Control systems and methods with versioning

ABSTRACT

Methods and apparatus for configuring process, environmental, industrial and other control systems generate and/or utilize models representing configurations of control systems and/or the systems controlled by them. Records of changes to the models or the configurations represented by them are maintained, thereby, for example, providing bases for determining current states, prior states and histories of changes. Objects in the model have characteristics, such as an object type characteristic and an area characteristic. Users can have corresponding permissions. A security mechanism apparatus controls access by users to the objects. Composite objects are defined by definition objects and are displayed in encapsulated or expanded formats. Objects can include an edit control type identifier that determines how they are presented for editing. Functionality responds to user commands by transferring characteristics of a first object depicted by the graphical user interface to a second object. Configuration-time formulas contained objects are evaluated to constants prior to downloading to the control system.

REFERENCE TO RELATED APPLICATIONS

This application claims the benefit of priority of U.S. Ser. No.60/134,597, filed May 17, 1999, entitled INTEGRATED DESIGN AUTOMATIONCONTROL ALGORITHM CONFIGURATOR ARCHITECTURE (Attorney Docket:102314-0045), the teachings of which are incorporated herein byreference.

This application is a continuation of copending, commonly assigned U.S.Ser. No. 09/448,845, filed Nov. 23, 1999, entitled METHODS AND APPARATUSFOR CONTROLLING OBJECT APPEARANCE IN A PROCESS CONTROL CONFIGURATIONSYSTEM (Attorney Docket: 102314-50), the teachings of which areincorporated herein by reference.

This application is a continuation of copending, commonly assigned U.S.Ser. No. 09/448,223, filed Nov. 23, 1999, entitled PROCESS CONTROLCONFIGURATION SYSTEM WITH CONNECTION VALIDATION AND CONFIGURATION(Attorney Docket: 102314-54), the teachings of which are incorporatedherein by reference.

This application is a continuation of copending, commonly assigned U.S.Ser. No. 09/448,374, filed Nov. 23, 1999, entitled PROCESS CONTROLCONFIGURATION SYSTEM WITH PARAMETERIZED OBJECTS (Attorney Docket:102314-46), the teachings of which are incorporated herein by reference.

BACKGROUND OF THE INVENTION

The invention pertains to control and, more particularly, to methods andapparatus for configuring control systems.

The terms “control” and “control systems” refer to the control of adevice or system by monitoring one or more of its characteristics. Thisis used to insure that output, processing, quality and/or efficiencyremain within desired parameters over the course of time. In manycontrol systems, digital data processing or other automated apparatusmonitor a device, process or system and automatically adjust itsoperational parameters. In other control systems, such apparatus monitorthe device, process or system and display alarms or other indicia of itscharacteristics, leaving responsibility for adjustment to the operator.

Control is used in a number of fields. Process control, for example, istypically employed in the manufacturing sector for process, repetitiveand discrete manufactures, though, it also has wide application inutility and other service industries. Environmental control findsapplication in residential, commercial, institutional and industrialsettings, where temperature and other environmental factors must beproperly maintained. Control is also used in articles of manufacture,from toasters to aircraft, to monitor and control device operation.

Modern day control systems typically include a combination of fielddevices, control devices, and controllers, the functions of which mayoverlap or be combined. Field devices include temperature, flow andother sensors that measure characteristics of the device, process orsystem being controlled. Control devices include valves, actuators, andthe like, that control the device, process or system itself.

Controllers generate settings for the control devices based onmeasurements from the field devices. Controller operation is typicallybased on a “control algorithm” that maintains a controlled system at adesired level, or drives it to that level, by minimizing differencesbetween the values measured by the sensors and, for example, a setpointdefined by the operator.

In a food processing plant, for example, a controller can be used tomaintain a soup stock at a simmer or low boil. This is done by comparingmeasurements of vapor pressure in the processing vessel with a desiredsetpoint. If the vessel pressure is too low, the control algorithm maycall for incrementally opening the heating gas valves, thereby, drivingthe pressure and boiling activity upwards. As the pressure approachesthe desired setpoint, the algorithm requires incrementally leveling thevalves to maintain the roil of the boil.

Controllers may be networked or otherwise connected to other computingapparatus that facilitate monitoring or administration. The so-calledS88 industry standard, described in Batch Control—Part 1: Models andTerminology (The International Society for Measurement and Control1995), for example, defines a hierarchy of processing and controlequipment (“equipment entities”) that can be used to model and controlan automated manufacturing process. At the lowest level of the hierarchyare control modules that directly manipulate field devices (e.g.,opening and closing valves) and, possibly, other control modules. At ahigher level, equipment modules coordinate the functions controlmodules, as well as of other equipment modules, and may execute phasesof the manufacturing process (such as setting controller constants andmodes). “Units,” at still a higher level of the hierarchy, coordinatethe functions of equipment and control modules. Process cellsorchestrate all processing activities required to produce amanufacturing batch, e.g., scheduling, preparing and monitoringequipment or resources, and so forth.

The principal function of controllers is executing control algorithmsfor the real-time monitoring and control of devices, processes orsystems. They typically have neither the computing power nor userinterfaces required to facilitate the design of a control algorithm.Instead, the art has developed configurators. These are typicallygeneral purpose computers (e.g., workstations) running software thatpermit an engineer or operator to graphically model a device, process orsystem and the desired strategy for controlling it. This includesenumerating field devices, control devices, controllers and otherapparatus that will be used for control, specifying theirinterrelationships and the information that will be transferred amongthem, as well as detailing the calculations and methodology they willapply for purposes of control. Once modeling is complete and tested, thecontrol algorithm is downloaded to the controllers.

One well known process control system configurator is that provided withthe I/A Series® (hereinafter, “IAS” or “I/A”) systems, marketed by theassignee hereof. These provide a graphical interface (FoxCAE) permittingan engineer to model a process hierarchically and to define a controlalgorithm from that hierarchy. Multiple editors are provided fordefining and modifying modules within the hierarchy.

Though prior art process control configuration systems, particularly,the IAS systems and others sold by the assignee hereof, have met wideacceptance in the industry, there remains room for improvement. Such isthe case, for example, with respect to the configuration of complexcontrol systems.

In this context, an object of the present invention is to provideimproved methods and apparatus for control and, particularly, forconfiguring control systems. A related object of the invention is toprovide methods and apparatus for configuring a process control systems.

A further object of the invention is to provide such methods andapparatus as facilitate configuring large or complex control systems

Still yet a further object of the invention is to provide such methodsand apparatus as can be used in configuring a range of control systems,whether hierarchical or not, whether pertaining to process control orotherwise.

SUMMARY OF THE INVENTION Versioning

The foregoing are among the goals attained by the invention whichprovides improved methods and apparatus for configuring a process,environmental, industrial and other control system. A configurationapparatus, according to one aspect of the invention, generates andutilizes a model representing a configuration of a control system and/orthe system being controlled by it. The apparatus maintains a record ofchanges to the model or the configuration represented by it and thereby,for example, provides bases for determining their current states, priorstates and histories of changes. This information can be tracked, forexample, from the moment a model or its components are created throughthe most current versions.

Further aspects of the invention provide such a configuration apparatusin which the model is composed of objects (or other data and/orprogramming constructs) that represent entities within any of thecontrol system, the controlled system, a control level hierarchy, and/orthe configuration apparatus itself. In aspects of the invention utilizedfor process control, objects can represent, by way of non-limitingexample, field devices, control devices, control processors, blocks,loops, compounds, historians, object type categories, objectconnections, parameter connections, display placeholders, graphicaldisplay entities, and reports. They can also represent entities of acontrol level hierarchy, e.g., sites, areas, process cells, units, andthe like.

A configuration apparatus, according to these and other aspects, canrecord changes by maintaining current and historical versions of theobjects that make up the model. This permits, for example, tracing thegenealogy of those objects forward and backward throughout the entiregenealogy representing each object's life cycle.

In addition to maintaining multiple historical versions of objects, aconfiguration apparatus according to further aspects of the inventioncan maintain not only the modeling objects but, also, versionsrepresenting configuration data that has been downloaded to the controlsystem for execution. That data can be, for example, binary or othermachine-readable data of the type understandable by the target controlsystem equipment.

Without limiting the invention, objects reflecting the model arereferred to as “offline” versions. A plurality of such objects arereferred as an “offline database.” Versions of the objects reflectingdata downloaded to, and running on, the control system are referred toas “online” versions. A plurality of these are referred to as an “onlinedatabase.”

Further aspects of the invention provide for thecoordination/synchronization of the object versions and control ofchanges made to them. According to one such aspect, the identity of anobject (or version) and/or the address, pointers or other referencesthereof or thereto remain constant during the lifetime of that object.As a consequence, for example, references to an object do not have to beupdated each time an object is edited.

In related aspects, an object that has been “checked out” for editing orother modification, e.g., by a user, is locked from modification byother users. A copy of that object maintained for purposes of editing,e.g., in a user “workspace” database, can be locked from all access byother users. For these purposes, among others, the current and/orworkspace versions of the object being edited can include a designationof the user who is making the modification. These locks can be releasedwhen editing is completed and the modified version is “checked in.”

On check-in, a modified version of an object replaces the currentversion which, itself, is retained as a prior historical version. Themodified object or the current version it replaces are, according toaspects of the invention, marked to indicate the user responsible forthe modification, as well as the modification made and the reasontherefor, e.g., based on information input by the user. The versions cancross-reference one another, forming a doubly-linked list that allowstraversal of the version tree for the object.

In related aspects of the invention, the online version of an object isupdated for correspondence with a new version of an offline object,thereby synchronizing the online and offline databases. The object iscompiled (or otherwise validated) and downloaded during this process,for operation on the control system.

Conversely, where an online version of an object is modified, aspects ofthe invention provide for generating a modified offline version thatcorresponds to it, e.g., via an “upload” procedure. That modifiedversion can replace the then-current offline version of the object inthe same manner discussed above.

Further aspects of the invention provide a configuration system asdescribed above that permit version “baselining,” e.g., where allcurrent objects in the off-line database are assigned a common versiondesignation.

Still further aspects of the invention provide mechanisms for viewing orediting information pertaining to the changes recorded by aconfiguration apparatus of the type described above. This includes

-   -   listing of objects being modified,    -   recording changes made to objects,    -   recording reasons for changes to objects,    -   releasing locks on objects,    -   checking-in objects that have been checked-out for modification,    -   viewing a version history of an object,    -   viewing a list of objects checked out by other users,    -   comparing objects,    -   comparing versions of an object,    -   compacting a version history,    -   marking objects with a common revision identifications,    -   archiving a model or its history of changes, and    -   generating an audit trail of changes.

Yet still further aspects of the invention provide apparatus asdescribed above that provide for system configuration on a computer thatis disconnected from that on which the offline database resides. Changesmade to that “disconnected” database can subsequently be merged into theoffline (and online) databases.

Security Control

A configuration apparatus, according to further aspects of theinvention, maintains a model comprising one or more objects thatrepresent entities in the control system, a system controlled thereby, acontrol level hierarchy, and the apparatus for configuring the controlsystem. Each of the objects has a plurality of characteristics such as,according to aspects of the invention, an object type characteristic andan area characteristic. Users can have corresponding permissions, e.g.,to access objects of defined types and/or within specified areas. Asecurity mechanism controls access by users, e.g., via applicationsprograms such as editors, to the objects. The level of access, e.g.,read-only vs. update, is a function of the multiple permissions held bythe user and the multiple characteristics of the object subject toaccess.

By way of example, the security mechanism permits a process engineerhaving appropriate permissions to create and maintain objects modelingcontrol loops for any building in a manufacturing plant configured byapparatus. It may, however, permit a nighttime operator to access onlyloops within his own building and to modify only those in the area towhich he/she is assigned.

Object types, according to aspects of the invention, identify objectsexhibiting related appearance and behavior. This may relate to theappearance/behavior of the entity modeled by the object or to the objectitself vis-a-vis the configuration apparatus. By way of example of theformer, objects that model two respective application workstations maybe of a common object type (i.e., a type indicating that they areapplications workstations), notwithstanding that the workstationsthemselves have different physical characteristics.

Area characteristics, according to related aspects of the invention,identify locations in which any of the control system and the systemcontrolled thereby are disposed. Area types can relate to, for example,plants, buildings or areas therein. Thus, for example, objects thatmodel process control equipment in the same area of a plant may have thesame area characteristic.

Object type characteristics and permissions, as well as areacharacteristics and permissions can, according to aspects of theinvention form respective hierarchies. In a system so embodied, forexample, a user having permissions for a designated area inheritspermissions for any area contained therein, as defined in the hierarchy.

Further aspects of the invention provide configuration apparatus asdescribed above in which users are members of groups that, themselves,have assigned access permissions. A user can be a member of multiplegroups and can have permissions afforded under any of them. Thus, forexample, in a process control aspect of the invention, a given user canbelong to both Process Engineer and Advanced Operator groups, thus,affording him/her access to any objects types and areas permitted formembers of either group.

In related aspects of the invention, the groups form a hierarchy, withgroups containing other groups, e.g., Operator group containing the TestOperator group. Each group holds the permissions of a group from whichit descends, as well as any other permissions assigned, e.g., by thesystem administrator.

In still further aspects of the invention, a user can change his/herpermissions, e.g., during the course of a session on the configurator.This is accomplished, for example, by activating specific permissionsfrom among a listing of allowable permissible, e.g., presented in adialog box. Thus, a user can to perform the majority of his/her dailyoperations with a default minimal security setting, then switch to amore restrictive security setting. Alternatively, or in addition, a usercan temporarily log-in as another user, e.g., as may be desirable toallow a supervisor to intervene during a user's session, perform arestricted operation, then log-out and return security to its previoussettings.

Composite Blocks

A configuration apparatus, according to further aspects of theinvention, maintains a model made up of objects that represent entitiesin the control system or the system controlled by it. Among the objectsare composite objects made up of other objects of types suitable forinclusion in the model independent of the composite objects. Thecomposite objects are defined by definition objects that can be changed,e.g., using an editor or other applications program. These changes carrythrough to the composite object, regardless of whether the changes aremade after the composite objects are created.

By way of example, a configurator according to the invention adapted forprocess control maintains a model including a composite object made upobjects representing control blocks. The model includes additionalobjects, some of which also model control blocks, but which are notincluded in the composite object. Changes to an object that defines thecomposite object carry through to that object, even if the changes aremade after the composite object is created and placed into the model.

Further aspects of the invention provide a configuration apparatus asdescribed above in which the objects that make up the composite object(referred to here as “component” objects) have parameters reflectingcharacteristics of the respective entities those parameters represent.The characteristics include, for example, inputs, outputs, alarm limits,control functions and display characteristics. Each parameter can, inturn, have attributes such as parameter name, parameter grouping,display label, data type, behavior, help information, edit type, datavalue range, formula definition, display format, and so forth.

Selected parameters of a composite's component objects are exposed forconnection to other objects in the model. An application, such as acontrol strategy editor, executing within the configurator permitsconnection between the composite and other objects via those selectedparameters. Conversely, such an application prevents external connectionwith component object parameters that are not exposed and that, instead,service connections internal to the composite object.

Further aspects of the invention provide a process control apparatushaving features like those described above comprising loop objects thatare made up of control blocks objects. Parameters of the componentobjects can be selected for connection to objects such as input/outputpoints (e.g., associated with sensors and actuators) external to thecomposite object.

Still further aspects of the invention provide a configuration apparatusas described above in which a composite object modifies a definitioninherited from its associated definition object. This can be achievedvia a modifier object that overrides one or more parameters supplied bycontrol block or other objects that make up the composite object.

Yet other aspects of the invention relate to configuration apparatus asdescribed above in which the application selectively displays thecomposite object in an encapsulated format or an expanded format. Theformer depict the object substantially with a single icon; the latter,with multiple icons that represent the respective composite's componentobjects.

Edit Selection

A configuration apparatus, according to further aspects of theinvention, maintains objects that represent entities in the controlsystem, the system controlled by it, a control level hierarchy and/orthe configuration apparatus itself. At least a selected object includesan edit control type identifier. An editor or other functionalitypermits editing of at least the selected object. To this end, itpresents the object for editing using an edit control that is based onthe edit control type identifier. An edit control, according to aspectsof the invention, includes a dialog box, list box, edit box, check box,or a combo box. It can also include a cell in a spreadsheet or propertysheet.

By way of example, a configurator according to the invention adapted forprocess control maintains objects representing control blocks and otherelements of the control system. A display presents a hierarchicallisting of the objects and permits a user to designate one for editing.When a user designates an object of interest, e.g., via a mouse click orother selection mechanism, an aspect of it is presented for editingusing an edit control based on the edit control type identifier providedwith the object.

According to related aspects of the invention, the edit control typeidentifier can directly indicate the edit control to be used inpresenting the selected object for editing. Thus, for example, theidentifier can be a numeric code corresponding to one of the foregoingedit control types. The edit control type identifier, moreover, can beselected from among several identifiers permissible for the selectedobject or other object with which it is associated.

To continue the example above, an editable aspect of the selected objectcan be list of values amenable to editing with a list box or check box.The object can include an edit control type identifier indicating thatone of those formats (e.g., the list box) and not the other is to beused when the object is selected for editing.

Still further aspects of the invention provide a configuration system asdescribed above in which at least the selected object has parametersidentifying characteristics of the entity represented by the object. Thecharacteristics include, for example, inputs, outputs, alarm limits,control functions and display characteristics. Each parameter can, inturn, have attributes such as parameter name, parameter grouping,display label, data type, behavior, help information, edit type, datavalue range, formula definition, display format, and so forth.

The editor or other such functionality of a configurator according tostill further aspects of the invention presents at least a selectedattribute with an edit control identified by the edit control typeidentifier. That attribute can be, for example, the data value of theparameters.

Yet other aspects of the invention provide a configurator as describedabove an edit control is populated with dynamically determined data. Forexample, a list box providing a list of workstations for selection by auser can be populated with identifiers of workstations present at thetime the list box is displayed. Alternatively, or in addition, aspectsof the invention provide for the display of non-dynamic or predeterminedvalues in an edit, e.g., yes/no, true/false, etc.

Object Swapping

A configuration apparatus, according to further aspects of theinvention, has a graphical user interface that graphically depictsobjects representing entities in the control system, the systemcontrolled by it, a control level hierarchy, and/or the apparatus forconfiguring the control system. An editor, or other functionality, thatis coupled with the graphical user interface displays icons or otherrepresentations of a first object and a second object. It responds to aselected user command by transferring characteristics of the firstobject to the second object. The command can be, according to one aspectof the invention, a drag-and-drop whereby an icon depicting the secondobject is graphically dragged and dropped onto an icon depicting thefirst object.

By way of example, a configurator according to the invention that isadapted for process control maintains objects representing controlblocks and other elements of a control system. A graphical userinterface, e.g., employed as part of a control strategy editor, displaysan icon depicting an IAS analog input block included in a control loop.An icon representing a Fieldbus Foundation analog input block isgraphically dropped onto the first icon by the user. In response, theeditor (or a configurator resource used by it) transfers characteristicsfrom the object modeling the IAS analog input block to the objectmodeling the Fieldbus Foundation block, swapping the latter for theformer and, thereby, facilitating configuration of the system.

Further aspects of the invention provide a configuration system asdescribed above in which the objects have parameters identifyingcharacteristics of the entities represented by them. The characteristicsinclude, for example, inputs, outputs, alarm limits, control functionsand display characteristics. Each parameter can, in turn, haveattributes such as parameter name, parameter grouping, display label,data type, behavior, help information, edit type, data value range,formula definition, display format, and so forth.

A configurator according to these aspects of the invention can transferparameters, attributes and/or values from the source object(representing the IAS analog input block in the example) to thedestination object (representing the Foundation Fieldbus block in thesecond example) in response to the drag-and-drop operation. Transferredvalues can be converted, e.g., to compensate for differences in scaling,units, and so forth, while they are being transferred.

Further aspects of the invention provide a configuration apparatus asdescribed above that includes an editor facilitating specification ofmappings and conversions used for the transfers. Such a “swap” editorcan use dialog boxes or other edit controls, graphical displays, and soforth, to display permissible mappings/conversions stored in a “swap”database or other data structure.

Configuration-Time Value Formulas

A configuration apparatus, according to further aspects of theinvention, has a plurality of objects modeling entities in the controlsystem or a system it controls. One or more of the objects have valuesthat are represented by formulas. Others have values that are constants.Functionality is provided to download portions of at least selectedobjects to the control system. Object values that are constants(numerical or otherwise) can be downloaded directly, e.g., after anyappropriate scaling, compilation and/or conversion, with thecorresponding objects. The functionality, however, evaluates (or invokesevaluation of) values that are formulas prior to their being downloaded.Evaluation entails, according to aspects of the invention, changing theformulas into numerical or other constants.

By way of example, a configurator according to the invention that isadapted for process control maintains objects representing controlblocks and other elements of a control system. One of the objects canhave real-valued parameters including, e.g., a high alarm value, HAL,and a low alarm value, LAL. An editor can be used to set the former,HAL, to the constant 100.0. Rather than using a constant for the latter,LAL, the editor permits its entry as a formula, e.g., my.HAL −100.0.Whereas the HAL value is downloaded directly to the control system(e.g., with appropriate scaling, compilation and/or conversion), the LALformula is converted, prior to downloading, to 0.0 (i.e., the value ofthe same object's HAL parameter minus 100).

Further aspects of the invention provide a configuration apparatus asdescribed above in which the formulas include mathematical operations,mathematical functions or references to characteristics of the same orother objects. The example above shows a formula that uses amathematical operation and that refers to another characteristic of thesame object. A formula can likewise refer to other objects, e.g.,objects modeling blocks, compounds, loops input/output tags, and otherelements of a process control system, by way of non-limiting example.

Yet still further aspects of the invention provide configurationapparatus as described above that provide an editor for entry andediting of formulas. Such editor can facilitate the inclusion ofobjects, object characteristics or mathematical functions in formulas,e.g., via display of lists of choices.

Further aspects of the invention provide a configuration system asdescribed above in which the objects have parameters identifyingcharacteristics of the entities represented by them. The characteristicsinclude, for example, inputs, outputs, alarm limits, control functionsand display characteristics. Each parameter can, in turn, haveattributes such as the aforementioned constant or fomulaic values, aswell as parameter name, parameter grouping, display label, data type,behavior, help information, edit type, data value range, display format,and so forth.

Parameterized Objects

An apparatus for configuring control systems according to furtheraspects of the invention employs objects (or other data and/orprogramming constructs) that inherit parameters from their ancestors.Changes to an ancestor during configuration are effective as to itsdescendant objects. A “configurator” apparatus according to theinvention can be used to model and define control algorithms for processcontrol, environmental control, industrial and other control systems.

To illustrate by way of a non-limiting example, an apparatus accordingto the invention for use in configuring process control systems canemploy an object to model a “conventional” analog input (AIN) fielddevice of the type used in a particular product. That object can includeoutput, high-high alarm, high-low alarm and other parameters of the typeused for modeling such devices. The apparatus can be used to define atconfiguration time a further object, one that models an analog inputdevice for use in high-temperature environments. That object can descendfrom the general AIN object and inherit its parameters, e.g., thehigh-high alarm and high-low alarm parameters. Configuration-timechanges to the parameters of the general AIN object can automaticallycarry through to the high-temperature AIN object, thus, facilitatingconfiguration of the process control system.

Objects used in apparatus according to these aspects of the inventioncan represent elements within a device, process or system beingcontrolled or entities within the configuration apparatus itself. Inprocess control, objects can represent, by way of non-limiting example,field devices, control devices, control processors, blocks, loops,compounds, historians, object type categories, object connections,parameter connections, display placeholders, graphical display entities,and reports. They can also represent entities of a control levelhierarchy, e.g., sites, areas, process cells, units, and the like.

Parameters define characteristics of each object and, therefore, of theelement or entity the object represents. Depending on the type ofobject, these include inputs, outputs, alarm limits, control functionsand display characteristics, among others. Each parameter can haveattributes that define the parameter's value and other attributes. Theseinclude, for example, parameter name, parameter grouping, display label,data type, behavior, help information, edit type, data value range,formula definition, and display format.

Objects used by an apparatus according to the invention can be definedor modified without recompilation. This is, in part, because theparameters on which they are based can be assigned and modified duringconfiguration and, in this regard, are analogous to data. To this end,apparatus according to the related aspects of the invention can includean editor that facilitates definition, during configuration, of anassociation between an parameter and an object. The apparatus canfurther include editors or other functionality that permit an object tobe defined as a descendant of another object at the time ofconfiguration.

An object so defined derives parameters from its ancestor which, inturn, derives parameters from its own ancestors, and so forth. Unlessotherwise overridden, a change to the parameters of an ancestor objectis effective as to its descendants, regardless of whether that change ismade before or after the descendant is defined or instantiated. Thus,for example, the characteristics of an entire ancestral “family” ofobjects can be changed, simply, by modifying the distant-most ancestorobject.

To illustrate by way of a non-limiting example, an apparatus accordingto the invention for use in configuring process control systems canemploy an object to model a “conventional” analog input (AIN) fielddevice of the type used in a particular product. That object can includeoutput, high-high alarm, high-low alarm and other parameters of the typeused for modeling such devices. The apparatus can be used to define atconfiguration time a further object, one that models an analog inputdevice for use in high-temperature environments. That object can descendfrom the general AIN object and inherit its parameters, e.g., thehigh-high alarm and high-low alarm parameters. Configuration-timechanges to the parameters of the general AIN object can automaticallycarry through to the high-temperature AIN object, thus, facilitatingconfiguration of the process control system.

Further aspects of the invention provide apparatus as described above inwhich an object can be associated with parameters other than thoseinherited from ancestors. Thus, for example, a high-temperature AINobject that inherits parameters from a general AIN object can be definedto include additional alarm parameters. Though definition of theadditional alarm parameters does not affect the parent object (i.e., thegeneral AIN object), it does carry through to children, grandchildren,etc., of the high-temperature AIN object.

Related aspects of the invention provide control system configurationapparatus as described above in which an object is associated with aparameter override or parameter modification. The former redefinesattributes for parameters inherited from an ancestor object, while thelatter can add entirely new parameters. Parameter overrides andmodifications carry through to descendants of an object to which theyare applied.

Still further aspects of the invention provide apparatus as describedabove in which the objects have parameters groups. These identifygroupings of parameters and relate to how they are presented to theengineer or operator during configuration, e.g., for editing. As withparameters, the groupings are inherited and can be overridden.

By way of example, an object that models a general proportional-integralderivative (PID) control block can be associated with two parametergroups, A and B, where Group A contains parameters X and Y, while GroupB contains parameters M and N. If edited during configuration, thatobject can appear with two sheets, one showing the parameters (X and Y)of Group A and one showing the parameters (M and N) of Group B. A newPID object can be defined that descends from the first object. Thedefinition can add a new group, Group C, that contains parameters W andX. If edited during configuration, the new object appears with threesheets, one showing the parameters (X and Y) of Group A, one showing theparameters (M and N) of Group B, and one showing the parameters (W andX) of Group C.

Further aspects of the invention provide a control system as describedabove in which classes defining the aforementioned objects aredownloaded from a manufacturer's site to an applications workstation,for example, as part of a contracted-for or e-commerce transaction,e.g., between the customer and the manufacturer. Objects instantiatedfrom those classes can be edited or used as a basis for modeling andcontrol system configuration.

Object Appearance

Improved apparatus for configuring process, environmental, industrialand other control systems according to further aspects of the inventionemploy “appearance” objects (or other data and/or programmingconstructs) defining the appearance of configurable system components ingraphical editors or other views in which the components may bedepicted. “Placeholder” objects (or other constructs) persist thelocation, size, color, or other aspects of appearance defined by anappearance object in displays, reports, depictions, presentations andother view (collectively, hereinafter, “views”) in which thecorresponding configurable component is actually depicted.

By way of example, a process control configuration apparatus accordingto this aspect of the invention uses “configurable” objects to defineblocks, loops and other components of a process control system.Appearance objects provide (or reference) icons or representationsindicating how the configurable objects are to be depicted, e.g., in aconfiguration editor. Placeholder objects are created for eachconfigurable object that is placed in a configuration using that editor.The placeholder objects identify the sizes, locations, colors, etc., ofthe icons used in the editor to represent the configurable objects.

Further aspects of the invention provide a configuration apparatus asdescribed above in which the appearance objects identify labels or othertextual information, e.g., configurable object names or types, fordisplay with icons or other appearance indictors in the appearanceobjects. According to related aspects of the invention, those labels, aswell as the icons themselves, can be specified using macros. Thus, forexample, an appearance object can include macro strings, such as“$NAME”, “$TYPE”, “$ICON”, that are replaced subsequent toconfiguration, e.g., with a configurable object name, type and icon,respectively.

The invention provides, in other aspects, apparatus as described abovein which each configurable object has one or more parameters thatidentify the appearance of that object in views in which it may appear.The parameters may refer to appearance objects (or other constructs) asdescribed above or they may contain appearance information (e.g., iconsand textual identifiers) themselves.

The configurable objects of such an apparatus can be associated with oneanother in a hierarchical relationship, such that at least one suchobject is a descendant of another. Descendants, according to this aspectof the invention, inherit parameters from their ancestors. Accordingly,icons or other appearance information identified in a “parent”configuration object is passed on to its children. Inherited informationmay be overridden, according to aspects of the invention.

Still further aspects of the invention provide apparatus as describedabove comprising persistent documents that contain placeholder objects.Each persistent document may represent a specific configuration, e.g.,created by a specific editor and displayed in accord with a selectedview. Thus, for example, the configuration of a process control systemmay be represented in several documents, each edited by controlalgorithm diagram editor, covering different portions of the system.

In addition to placeholder objects, the persistent document may containconnector graphics that depict relationships between configurableobjects. In an apparatus used for configuring process control systems,such a graphic may indicate, for example, that one configurable object,e.g., representing an analog input block, is a source for anotherconfigurable object, e.g., representing a PID controller. Such connectorgraphics can represent peer-to-peer relationships (such as source/sinkrelationships), in addition to hierarchical relationships (such asparent/child relationships).

Further aspects of the invention provide apparatus as described abovefor configuring process control systems. In such apparatus, configurableobjects can, for example, represent entities within any of (i) acontrolled process, (ii) the process control system, (iii) the apparatusfor configuring the process control system, (iv) a level in a controllevel hierarchy, such as the aforementioned S88 standard. Such entitiesinclude, by way of non-limiting example, field devices, controlprocessors, blocks, loops, compounds, historians, object type category,display placeholders, graphical display entities, and reports.

Connection Validation and Configuration

Improved apparatus for configuring process, environmental, industrialand other control systems according to further aspects of the inventionemploy “connection” objects (or other data and/or programmingconstructs) that indicate the permissibility of relationships betweenother types of objects. The apparatus validate potential relationshipsbetween those other objects by comparing their types with thepermissible combinations identified in connection objects.

Those other objects can, for example, represent entities within any of(i) a controlled system, (ii) a control system, (iii) an apparatus forconfiguring the control system, (iv) a control level hierarchy. Suchentities include, by way of non-limiting example, field devices, controlprocessors, blocks, loops, compounds, historians, object type category,display placeholders, graphical display entities, and reports.

An apparatus as described above can be used, for example, to facilitateconfiguring a process control system. Using a graphical user interface,a user can “drag-and-drop” an object that models one system component(e.g., a printer) onto an object that models another component (e.g., anapplications workstation), indicating that the user wishes to establisha relationship between those two objects. Through the connectionobjects, the apparatus validates that relationship and determines itstype—in this case, a parent/child (or other hierarchical) relationship.

By way of further example, the apparatus can use connection objects tovalidate relationships that are peer-to-peer in nature, i.e.,source/sink relationships. To illustrate, the user of can select objectsthat represent field devices and indicate (e.g., via a drag-and-dropoperation, a menu option or other command) that she wishes to establisha relationship with an object that represents a control processor. Theapparatus can validate that relationship, and determine its type (i.e.,source/sink), by comparing the proposed combination against permissiblepairings in the connection objects.

Object types can be hierarchical, according to further aspects of theinvention. For example, a user-defined analog input (AIN) object typecan be defined as hierarchically descending from a standard AIN type.Likewise, a specific class of personal computer can be defined asdescending from branches of a hierarchy indicating that it issubcategory of applications workstation and, more particularly, asubcategory of Windows™ NT workstation

An apparatus according to the invention can utilize this object typehierarchy in validating relationships between objects. Thus, forexample, a relationship proposed by the user can be validated if theimplicated objects or their hierarchical ancestors are identified aspermissible pairings in a connection object.

Further aspects of the invention provide apparatus as described above inwhich the connection objects specify roles that objects serve in actualor potential relationships. Those roles can include, for example, asource or sink in a source/sink relationship, or a parent or child in aparent/child relationship.

In still further aspects, an apparatus as described above can utilizethe connection objects to identify the maximum capacity of an objectthat serves as a “parent” to support objects that serve as “children” ina parent/child relationship. The connection objects can likewiseidentify the weight (or other quantitative attribute) each child objectcontributes in its role in such a relationship. An apparatus asdescribed above can similarly utilize the connection objects to identifythe minimum and maximum numbers of relationships that can be establishedwith sources or sinks in source/sink relationships.

By way of example, a connection object may indicate that a controlprocessor object type can serve as a parent to a specified number offield devices. As the user establishes relationships between a controlprocessor object and multiple field device objects, the apparatus totalsweights associated with the latter. If the combined weight exceeds theparent control processor's specified capacity, the apparatus preventsestablishment of the relationships.

Yet still further aspects of the invention provide apparatus asdescribed above in which the first connection object identifies not onlypermissible relationships between object types, but also actualrelationships between specific objects.

According to further aspects of the invention, aspects of the inventionpertain to configuration apparatus paralleling those described above, inwhich connection objects identify permissible combinations of parametertypes (as opposed to, or in addition to, object types) that can formvalid parent/child and source/sink relationships.

Such apparatus can automatically establish parameter-to-parameterconnections of selected objects by comparing the types of thoseparameters with valid pairings identified in a connection object. Tocontinue the above example, once a relationship is validated between AINand PID objects and once the nature of that relationship (source/sink)is determined, an apparatus according to this aspect of the inventioncan form a connection or relationship between the PNT (point) output ofthe AIN object and the MEAS (measurement) input of the PID object.

Such apparatus can also validate parameter-level relationshipsidentified by an operator, e.g., in a drag-and-drop operation. Thus, forexample, using a graphical user interface, a user can “drag-and-drop” aparameter of one object (e.g., the parallel output of an objectrepresenting an applications workstation) onto the parameter of anotherobject (e.g., the parallel input of an object representing a printer),indicating that the user wishes to establish a relationship betweenthose two objects. Through the connection objects, the apparatusvalidates that relationship and determines its type—in this case, asource/sink relationship.

Still further aspects of the invention provide apparatus as describedabove in which establishment of certain connections (e.g., “master”connections) between parameters automatically causes others (“slave”connections) to be established. By way of example, once a connection isestablished between the PNT parameter of an AIN object and the MEASinput parameter of a PID object, “slave” connections are made betweenrelated parameter pairs (e.g., low and high scale parameters) of theseobjects. Slave connections are automatically updated or destroyed whenthe corresponding master connection is updated or destroyed.

Still further aspects of the invention provide combinations of thesystems and apparatus described above.

Yet still further aspects of the invention provide methods forparalleling the operations described above.

These and other aspects of methods and apparatus according to theinvention are evident in the drawings and in the description below.

Methods and apparatus according to the invention have numerousadvantages over the prior art. Among these is the ability to quickly,flexibly and accurately design and modify control configurations.

BRIEF DESCRIPTION OF THE DRAWINGS

A more complete understanding of the invention may be attained byreference to the drawings, in which:

FIG. 1 depicts a a digital data processing environment of the type inwhich the invention is practiced;

FIG. 2 depicts a process control system of the type with which theinvention is practiced;

FIG. 3 depicts control algorithm configurator components in a systemaccording to the invention;

FIG. 4 depicts component interaction in a system according to theinvention;

FIG. 5 depicts an IDA framework object model in a system according tothe invention;

FIG. 6 depicts an object model notation used in this application;

FIG. 7 depicts a parameterized object model in a system according to theinvention;

FIG. 8 depicts parameter group inheritance in a system according to theinvention;

FIG. 9 depicts a parameterized object example in a system according tothe invention;

FIG. 10 depicts the creation of a parameter list in a system accordingto the invention;

FIG. 11 depicts a parameter definition editor in a system according tothe invention;

FIG. 12 is a parameter editor example in a system according to theinvention;

FIG. 13 depicts object types in a system according to the invention;

FIG. 14 depicts an object type hierarchy in a system according to theinvention;

FIG. 15 depicts the creation of new object types in a system accordingto the invention;

FIG. 16 is a type awareness example in a system according to theinvention;

FIG. 17 depicts a connection object model in a system according to theinvention;

FIG. 18 depicts a parameterized object override endpoint triad in asystem according to the invention;

FIG. 19 depicts an object connection type object model in a systemaccording to the invention;

FIG. 20 is an example of simultaneous parent/child object connectivityin a system according to the invention;

FIG. 21 depicts a parameter connection type object model in a systemaccording to the invention;

FIG. 22 is an example of simultaneous source/sink parameter connectivityin a system according to the invention;

FIGS. 23-25 are parent/child connectivity examples in a system accordingto the invention;

FIG. 26 is a source/sink connectivity example in a system according tothe invention;

FIG. 27 depicts an appearance object model in a system according to theinvention;

FIG. 28 is an appearance definition example in a system according to theinvention;

FIG. 29A depicts a placeholders object model in a system according tothe invention;

FIG. 29B depicts a combined appearance and placeholder object model in asystem according to the invention.

FIG. 30 depicts a MFC document/view architecture in a system accordingto the invention;

FIG. 31 depicts an IDA application class architecture in a systemaccording to the invention;

FIG. 32 depicts an IDA document architecture in a system according tothe invention;

FIG. 33 depicts IDA hierarchy classes in a system according to theinvention;

FIG. 34 depicts IDA view classes in a system according to the invention;

FIG. 35 depicts IDA frame classes in a system according to theinvention;

FIG. 36 depicts a sheet templates object model in a system according tothe invention;

FIG. 37 depicts a sample use of macros in sheet template in a systemaccording to the invention;

FIG. 38 depicts a sheet template editor in a system according to theinvention;

FIG. 39 depicts an IDA report manager object model in a system accordingto the invention;

FIG. 40 depicts the application of filter rules to POC in a systemaccording to the invention;

FIG. 41 depicts a filter editor in a system according to the invention;

FIG. 42 depicts a composite report template editor in a system accordingto the invention;

FIG. 43 depicts a report editor in a system according to the invention;

FIG. 44 depicts organizational folders in a system according to theinvention;

FIG. 45 depicts version control basic concepts in a system according tothe invention;

FIG. 46 depicts an object check out in a system according to theinvention;

FIG. 47 depicts an check in a system according to the invention;

FIG. 48 depicts a revision editor in a system according to theinvention;

FIG. 49 depicts a create revision dialog box in a system according tothe invention;

FIG. 50 depicts parameterized object versions in a system according tothe invention;

FIG. 51 depicts a version control object model in a system according tothe invention;

FIG. 52 depicts a version history in a system according to theinvention;

FIG. 53 depicts an object compare utility in a system according to theinvention;

FIG. 54 depicts an historical archive with playback macro in a systemaccording to the invention;

FIG. 55 depicts performing a macro playback in a system according to theinvention;

FIG. 56 depicts a sample audit trail report in a system according to theinvention;

FIG. 57 depicts an undo manager object model in a system according tothe invention;

FIG. 58 depicts an users and security object model in a system accordingto the invention;

FIG. 59 is an users and groups example in a system according to theinvention;

FIG. 60 is a process area and assignable objects example in a systemaccording to the invention;

FIG. 61 depicts a IDA permissions hierarchy in a system according to theinvention;

FIG. 62 depicts a switch group/user capability in a system according tothe invention;

FIG. 63 depicts managing groups in a system according to the invention;

FIG. 64 depicts assigning users to groups in a system according to theinvention;

FIG. 65 depicts groups, object types and permissions in a systemaccording to the invention;

FIG. 66 depicts managing process areas in a system according to theinvention;

FIG. 67 depicts groups and process area permissions in a systemaccording to the invention;

FIG. 68 depicts a system tree view in a system according to theinvention;

FIG. 69 depicts a block definition editor in a system according to theinvention;

FIG. 70 depicts a block definition classes in a system according to theinvention;

FIG. 71 depicts a simple loop in a system according to the invention;

FIG. 72 depicts a composite block definition in a system according tothe invention;

FIG. 73 depicts a composite block in loop in a system according to theinvention;

FIG. 74 depicts an expanded composite block in loop in a systemaccording to the invention;

FIG. 75 depicts a block with connections in a system according to theinvention;

FIG. 76 depicts the anatomy of a block placeholder in a system accordingto the invention;

FIG. 77 depicts a block connection dialog in a system according to theinvention;

FIG. 78 depicts template/definition internal connections in a systemaccording to the invention;

FIG. 79 depicts template/definition exposed connections in a systemaccording to the invention;

FIG. 80 depicts a parameter property sheet in a system according to theinvention;

FIG. 81 depicts a composite block property sheet in a system accordingto the invention;

FIG. 82 depicts a parameter formula builder in a system according to theinvention;

FIG. 83 depicts control object derivations in a system according to theinvention;

FIG. 84 depicts a block object model in a system according to theinvention;

FIG. 85 depicts a modifier block object model in a system according tothe invention;

FIG. 86 depicts a modifier block parameter override precedence in asystem according to the invention;

FIG. 87 depicts a composite block definition object model in a systemaccording to the invention;

FIG. 88 depicts a loop template object model in a system according tothe invention;

FIG. 89 depicts a simple loop object model in a system according to theinvention;

FIG. 90 depicts a composite block object model in a system according tothe invention;

FIG. 91 depicts a template derived loop object model in a systemaccording to the invention;

FIG. 92 depicts object placeholder derivations in a system according tothe invention;

FIG. 93 depicts persistent document object derivations in a systemaccording to the invention;

FIG. 94 depicts a PLB to ladder relationship in a system according tothe invention;

FIG. 95 depicts a ladder editor view in a system according to theinvention;

FIG. 96 depicts ladder objects in a system according to the invention;

FIG. 97 depicts persistent document objects; in a system according tothe invention;

FIG. 98 depicts a PLB block model in a system according to theinvention;

FIG. 99 depicts a block execution scheduler editor in a system accordingto the invention;

FIG. 100 depicts a station statistics dialog in a system according tothe invention;

FIG. 101 depicts a block execution editor object model in a systemaccording to the invention;

FIG. 102 depicts a tag list data entry screen in a system according tothe invention;

FIG. 103 depicts a tag list import from ASCII file in a system accordingto the invention;

FIG. 104 depicts a tag list export to ASCII file in a system accordingto the invention;

FIG. 105 depicts a tag list import/export from database table in asystem according to the invention;

FIG. 106 depicts a tag list object model in a system according to theinvention;

FIG. 107 depicts download target selection in a system according to theinvention;

FIG. 108 depicts a download manager document object in a systemaccording to the invention;

FIG. 109 depicts a download services object model in a system accordingto the invention;

FIG. 110 is an historian assignment overview in a system according tothe invention;

FIG. 111 depicts an individual compound assignment in a system accordingto the invention;

FIG. 112 depicts an historian object model in a system according to theinvention;

FIG. 113 depicts an enclosure group view in a system according to theinvention;

FIG. 114 depicts an enclosure loading view and tag assignment dialog ina system according to the invention;

FIG. 115 depicts an enclosure input/output termination view in a systemaccording to the invention;

FIG. 116 depicts an enclosure loading model in a system according to theinvention;

FIG. 117 depicts an enclosure definition detail model in a systemaccording to the invention;

FIG. 118 depicts persistent document objects in a system according tothe invention;

FIG. 119 depicts an IDA main application architecture in a systemaccording to the invention;

FIG. 120 depicts a typical IDA generic editor frame in a systemaccording to the invention;

FIG. 121 depicts IDA & OLE compound documents in a system according tothe invention.

DETAILED DESCRIPTION OF THE ILLUSTRATED EMBODIMENT

FIG. 1 depicts a digital data processing system of the type with whichapparatus and methods according to the invention may be practiced. Theillustrated system is particularly adapted for use in connection withprocess control, as discussed further below. However, those skilled inthe art will appreciate that apparatus and methods according to theinvention can be used in connection with other control systems. In thisregard, processes 12A, 12B can represent any industrial, manufacturing,service, environmental or other process, device or system amenable tomonitoring or control (hereinafter, collectively, “control”).

The system of FIG. 1 includes a workstation 11 that is coupled to one ormore controllers 10A, 10B on which reside process control systems formonitoring and/or controlling one or more processes 12A, 12B. These mayrepresent independent processes or different aspects of the same orrelated processes. Moreover, the processes 12A, 12B may reside within asingle plant, site or area, cell or unit or, conversely, they maydispersed among many plants, sites, areas, cell or units.

Workstation 11 represents an engineering workstation, personal computer,mainframe computer or other digital data processing device suitable foroperation in accord with the methods described herein for purposes ofmodeling a control system and configuring controllers 10A, 10B or othercontrol or controlled apparatus in accord with the teachings herein. Ina preferred embodiment of the invention, workstation 11 is anengineering workstation or personal computer executing the Windows NToperating system. Though illustrated as being carried out on workstation11, those skilled in the art will appreciate that the modeling andconfiguration functions described herein can be executed on suitablyconfigured controllers 10A, 10B (e.g., those having sufficientprocessing power and interfaces to provide the graphical and otherconfiguration functions described herein).

Server 16 represents an optional additional source of classes definingobjects for modeling a control system and for configuring controllers10A, 10B (or other control or controlled apparatus) in accord with theteachings herein. This can include, for example, a retail store,warehouse or other distribution point of CDROMs, diskettes or othermagnetic medium on which such classes are stored. In a preferredembodiment, however, it represents a digital data processor thatfunctions as a server, e.g., maintained by a manufacturer or otherdistributor, from which such classes can downloaded to workstation 11,e.g., as part of an e-commerce transaction, for configuration prior todownloading to controllers 10A, 10B.

Network 14 provides a communications medium permitting the downloadingof control algorithms and other configuration information to controllers10A, 10B, e.g., from workstation 11. It can also of provide a medium foruploading information from controllers 10A, 10B to those other digitaldata processors 11, 16. Still further, it can provide a medium forcommunications, real-time or otherwise, between the controllers 10A, 10Band other devices, e.g., workstation 11 and server 16. Thoughillustrated to represent a LAN, WAN, or global network (Internet), thoseskilled in the art will appreciate that element 14 may represent anymedium or mechanism through which control algorithms and otherinformation may be transported, electronically, physically or otherwise,to and from controllers 10A, 10B.

An exemplary control process 12A is illustrated in greater detail inFIG. 2. It shows a process including valve 18 that governs the rate offluid flow to aeration tank 20 which, in turn, transfers the liquid tostorage tank 22. Field devices, i.e., sensors 24 and 26, monitor thestate of process 12A and, thereby, facilitate its control by processcontrol system 28 operating on controller 10A. Thus, sensor 24 isdisposed in or adjacent to tank 20 for measuring the temperature offluid therein, while sensor 26 measures the flow of fluid from aerationtank 20 to storage tank 22.

FIG. 2 further illustrates a control algorithm 28 of the type that canbe configured by methods and apparatus according to the invention. Thealgorithm 28 is exercised by controller 10A to control process 12A. Thealgorithm 28 includes blocks or other entities 29, 30, 32, that modelfield devices, control devices and other elements within process 12A andthat monitor and/or control the states and interactions between thoseentities.

Entities 29, 30, 32 comprise software components which may include, bynon-limiting example, source, intermediate or executable code,databases, of the type conventionally used in the art for operatingcontrollers, field devices, control devices and other process controlequipment. Referenced in this regard in the discussion below aresoftware components, and process control systems in general, marketed asthe I/A Series® systems (hereinafter, “IAS” or “I/A”) available from theassignee hereof. Those skilled in the art will appreciate that methodsand apparatus according to the invention can be used to model processesand configure control algorithms for use with other control systems, aswell.

Described below is a system, alternately referred to as the IDA ControlAlgorithm Configurator, the Configurator, IDA, and the like, accordingto one embodiment of the invention for use modeling and configuringcontrol processes. Referring to FIG. 3, the Configurator includes aFramework, a Database, a project manager and a set of editors. TheFramework provides common resources, such as menus, toolbars, dialogs,and security services, used by the editors to manipulate, display andreport configuration data stored in the IDA database. In one preferredpractice of the invention, the IDA Control Algorithm Configurator andFramework are packaged as a single application. This software packagecan be installed on either a stand-alone PC, workstation (e.g., element11 of FIG. 1) or other digital data processor, e.g., running Windows NTor any other suitable operating system.

The editors are used by the implementation creator to create andmaintain standard control scheme definition objects distributed with theimplementation and by users to create their own plant control schemes.The Project Manager allows the user to browse through the projectconfiguration hierarchies and data. Interactions among the editors andthe project manager/navigator are shown in FIG. 4.

The database forms part of an object oriented database management system(OODBMS), which may be any type commercially available in themarketplace. The database can be deployed in a client/serverconfiguration with a single centralized database per plant servicingmultiple clients, or otherwise. It resides on the workstation 11, e.g.,or on a digital data processor coupled therewith.

Part 1—Framework Classes 1 IDA Framework Object Model

FIG. 5 presents the primary component parts of the overall IDA Frameworkobject model. The model may be broken into two major areas:

-   -   1. Parameterized Objects.    -   2. Framework Services, which are provided in order to allow        controlled access to those objects, and how they might be used        to display, print and otherwise manipulate Parameterized        Objects.

In the discussion that follows object classes and their variousassociations are represented in the manner shown in FIG. 6.

1.1 Objects and Parameters

Almost all objects in IDA are parameterized—i.e., their type isdetermined by the parameter set they support, and the data that theseobjects represent is contained within their associated parameters.Parameterized objects have the capability to inherit their parameter setfrom another Parameterized Object which acts as the definition for thenew object. A Parameterized Object's definition is, itself, aParameterized Object.

Using Parameters to define an object's type, and the data associatedwith it, provides the following capabilities:

-   -   Parameters represent data—they aren't compiled-in behavior.    -   Parameterized Objects support data inheritance—a Parameterized        Object inherits its structure and default values from its        defining object.    -   Any object can override the default value of various attributes        of an associated Parameter. Referred to as parameter        instantiation by exception, only the Parameter attributes that        differ from their defaults are instantiated, and attached to the        object.    -   Parameters associated with a Parameterized Object can also be        changed by the application of a modifier object, effectively        overriding the default value(s) of any matching Parameters.    -   A change to a Parameter in a Parameterized Object acting as a        definition is reflected in all the Parameterized Objects that        are derived from the defining Parameterized Object.    -   Parameterized Objects can extend their definition by adding        additional Parameters.    -   Parameters are organized into groups, each group containing        logically-related Parameters. Groups can be pre-defined and/or        defined by the user.

Given the complex nature of Parameterized Objects and their parametersets, a simple interface for the developer is provided in which itappears that a Parameterized Object consists of a self-contained,cohesive set of parameters when in reality, data inheritance, parameteroverrides, and modifications are all acting together to determine finalparameter values.

1.1.1 Object Model

The overall object model for Parameterized Objects, and ParameterizedObject Collections is depicted in FIG. 7.

1.1.1.1 Parameterized Object

A Parameterized Object is a persistent object. The parameters associatedwith a Parameterized Object are both locally defined (as depicted in theobject model) and inherited. The locally defined parameters are thosedefined by the Parameter Definition objects. The inherited parametersare those that are inherited through an association to anotherParameterized Object typically serving as a definition.

-   -   A Parameterized Object has an ordered one-to-many association        with the Parameter Definition object. This represents the set of        locally defined parameters which “belong” to, and ultimately        define, this object.    -   A Parameterized Object maintains a list of parameter overrides,        in the form of Parameter Value and/or Parameter Override        objects. Parameter Value objects are used to override the actual        parameter value, and other important attributes such as high and        low limits. Parameter Override objects are used to override all        other editable parameter attributes. Only inherited parameters        are overridden—locally defined parameters simply have the        appropriate attribute value changed within the associated        Parameter Definition.    -   A Parameterized Object has an association to another        Parameterized Object from which it inherits parameters. It is a        zero-or-one association, and is referred to as its Definition,        or parent, Parameterized Object. If a Parameterized Object does        not have a definition, then it is considered to be a root        Parameterized Object. A root Parameterized Object defines all of        its parameters, not relying on another object to inherit them        from. If a Parameterized Object has a Definition Parameterized        Object association, then the Parameterized Object is a derived        Parameterized Object. The derived Parameterized Object gets its        parameters by inheriting them from the defining object and by        adding its own through local Parameter Definition associations.    -   A Parameterized Object maintains a list of other Parameterized        Objects that inherit its parameters. A Parameterized Object        whose parameters are inherited by other parameterized objects is        referred to as a Definition, or parent, Parameterized Object.        There is no limit as to the number of objects for which a        Parameterized Object can act as a definition.    -   A Parameterized Object maintains an ordered list of Parameter        Groups associated with it. This association gives the        Parameterized Object an ordered set of labels to put on the tabs        of the Parameterized Objects' property page tabs while being        edited, or on tabs at the top of the Parameterized Object        editor. Parameter Groups, in turn, maintain an association with        zero or more Parameter Definitions.    -   The Parameter Definition order maintained by the Parameterized        Object applies across all Parameter Groups that the parameters        belong to. In other words, if parameter A comes before parameter        B in the association between Parameterized Object and Parameter        Definition, then A will preferably appear before B whenever the        two parameters are displayed in the same group.    -   A Parameterized Object may be contained within a parameterized        object collection object, which may be either a single- or        multiple-collection instance of Parameterized Object collection.        In turn, parameterized object collections may contain zero or        more parameterized objects.    -   An instance of Parameterized Object may be associated with zero        or more other Parameterized Objects that are referred to as        Modifier Parameterized Objects. The Parameter Values in the        Modifier Parameterized Objects are used to override the        parameters of the Parameterized Object. An instance of a        Parameterized Object can have zero or more of these modifiers to        modify their parameters. If an object has more than one        modifier, the modifications are made in the order that the        modifier objects were applied, with the resulting overrides        representing the accumulative effect of having applied all the        modifications.    -   The Framework provides the method(s) necessary in order to        determine the behavior of a modifier object. By default, the        Parameter Values in the Modifier which aren't associated with        any Parameter Definitions (local or inherited) of the object        being modified are ignored. However, there may be circumstances        under which a developer needs to have all Parameter Definitions        applied to the object being modified, potentially adding new        parameters to the object.

1.1.1.2 Parameterized Object Collection Classes

A Parameterized Object Collection is just that—a collection of one ormore Parameterized Objects. Applications programs can add or deleteelements from the collection, and iterate through it. ParameterizedObject Collections have the ability to support multiple collections. Forexample, a loop could collect both blocks and connections, whereas acompound could have a separate collection of blocks for each controlzone.

Consequently, the Parameterized Object Collection classes have beenseparated into two classes, each of which will be able to support manydifferent collection types, which include Lists (insert after/before),Arrays (indexed access, and “null” locations), and possibly Maps (orDictionaries). These collection classes are:

-   -   1. Single-Collection. Instances of this class contain a single        collection, presented as a single ordered list of objects.    -   2. Multiple-Collection. Instances of this class contain        multiple, named collections. These named collections are        references to instances of collections (i.e., instances of the        Contained Collections) which are managed by the        Multiple-Collection instance. Each collection within a        Multiple-Collection object can be a different type (for example,        a list and an array).

1.1.1.3 Parameter Definition

The Parameter Definition object defines the values for the attributes ina parameter. Even though it is only directly associated with oneParameterized Object, it may indirectly belong to many otherParameterized Objects via the parameter inheritance mechanism describedin the discussion on Parameterized Objects.

The parameter object consists of a set of attributes. The attribute setis compiled-in behavior, and the value of each attribute is changed asneeded to satisfy the requirements of the associated ParameterizedObject. A Parameter Definition does not exist alone, but only in thecontext of a Parameterized Object.

In the illustrated embodiment, the minimum attribute set for a ParameterDefinition is as follows:

Name The unique identifier for accessing the parameter within aParameterized Object. There cannot be more than one parameter in aParameterized Object with the same name. This is the name used whendownloading the parameter to a target machine. Group A list of ParameterGroups which this parameter belongs to. Label An internationalizablestring used to label the Parameter in the user interface. Data Specifiesthe data type of the Parameter. Integer, float, boolean, and Type stringare examples of a data type. Depending on implementation, the length ofthe data can be either an attribute of the data itself or of theParameter Definition. Can also be implemented via sub-classes ofParameter Definition. Behavior Specifies a set of behaviors theParameter exhibits. Examples include whether the parameter could beedited or associated with another Parameter. This can be implemented asa bitmask. Help Specifies internationalizable help associated with theparticular Parameter Definition. The help consists of both a verbose andterse version. The verbose version is used by the help system and theterse version is used for such things as short messages and tool tips.Edit Specifies a specific control type used to edit the value attributeControl associated with the Parameter Definition. This edit control typeis Type used by any application editing this parameter, whether it isdisplayed in a property sheet, or in a spreadsheet format. RangeSpecifies a range of valid values for the Value attribute. ValueSpecifies the value of the Parameter. This value is type specific whichis specified by the type attribute. Formula Provides a placeholder tocontain the user-provided formula for Parameter Definitions which havetheir Value attribute determined by a formula. Format Specifies aC-printf type specification for displaying the value attribute.

-   -   The Parameter Definition object has a many-to-many association        to the Parameter Group object. A Parameter Definition can belong        to many groups, allowing the parameter to be displayed in        multiple tabs on a Parameterized Object property sheet. The        order of parameters within any Parameter Group is determined by        the ordering maintained by the Parameterized Object.    -   The Parameter Definition object has a many-to-one association to        the Parameterized Object. Although it may be inherited by        several Parameterized Objects, a Parameter Definition belongs        directly to (locally defined by) one and only one Parameterized        Object. A Parameterized Object contains an ordered set of zero        or more Parameter Definitions.

1.1.1.4 Parameter Value

An instance of the Parameter Value object is created whenever specificattributes of a Parameter Definition instance are overridden—namely,value, high range and low range. Any other attribute of a ParameterDefinition which is overridden is specified by a Parameter Overrideobject. It is important to note that a Parameter Value exists byexception only—in other words, it exists only if the associatedParameter Definition is overridden by a Parameterized Object located“down” the ancestral tree from the Parameterized Object where theParameter Definition was originally defined. Overrides of a locallydefined Parameter Definition simply replace the appropriate value withinthe Parameter Definition itself.

-   -   A Parameter Value is associated with one, and only one,        Parameter Definition, by name. Attributes of the same Parameter        Definition, however, may be overridden by multiple Parameter        Values when viewed in the context of the Parameterized Object        hierarchy chain.    -   The final value of any parameter attribute is determined by        traversing the Parameterized Object hierarchy back to the        object's root, then sequentially applying overrides (and/or        modifiers) appropriately going forward down the object's        hierarchy chain.    -   Each Parameterized Object maintains a list of zero or more        Parameter Value objects. This list represents the set of locally        defined value overrides associated with this Parameterized        Object.

1.1.1.5 Parameter Override

The Parameter Override object is used by a Parameterized Object tooverride attributes of inherited parameters other than value, highrange, and low range. Attributes which are typically overridden usingthis object include which parameter groups a parameter belongs to,format, and help strings.

-   -   A Parameter Override object is derived from the Parameter Value        class. As such, it inherits all the behavior and attributes of        the Parameter Value class in terms of existing by exception        only, and how the final value of attributes modified within a        Parameter Definition are determined.    -   A Parameter Override has a “special” relationship to Parameter        Groups, in that one of the attributes of a Parameter Definition        is a string containing all of the names of the groups which that        parameter belongs to. In this relationship, the same Parameter        Override may specify many Parameter Groups. In turn, the same        Parameter Group may be referenced by several Parameter        Overrides, resulting in a many-to-many relationship. As with        other relationships dealing with Parameter Values and Overrides,        this one is resolved by parameter name.

1.1.1.6 Parameter Group

The parameter set that defines the structure of a Parameterized Objectis segregated into named Parameter Groups. These groups are directlyrelated to the tabs contained within the property sheet for theParameterized Object when it is edited, as well as the tabs visible onthe Parameterized Object editor. Each parameter defined in an objectbelongs to one or more Parameter Groups.

Parameterized Objects inherit their Parameter Groups in the same waythey inherit Parameter Definitions. As depicted in FIG. 8, aParameterized Object may add additional groups to the inherited list.The order of Parameter Groups, and the parameters within those groups,is also inherited, and is determined by the ordered list of parametersmaintained by the Parameterized Object hierarchy chain.

In FIG. 8, an object Foxboro_PID is associated with two groups, A and B.Group A contains two parameters, X and Y, while Group B containsparameters M and N. A new object is created, using Foxboro_PID as it'sdefinition object. A new group, C, has been defined for My_PID, whichcontains parameters W and X. A new parameter, Z, has been added to theinherited group, A.

When the object My_PID is edited, a property sheet with three tabsappears. The tabs are labeled A, B and C. If the user edits group A,parameters X, Y and Z are shown, in that order. Note that if a change ismade to the value for parameter X, and switches to group C, the newvalue for X will be displayed.

The user can add new parameters (and define their order) to an inheritedgroup, but not change the order of any of the inherited parameterscontained in the group. All inherited parameters appear first on theproperty page, followed by the parameters which were added locally.Similarly, the user can add local groups, but cannot change the order ofinherited groups when displayed on the property sheet. Local groupsappear after inherited groups.

1.1.2 A Simple Parameterized Object Example

The example in FIG. 9 shows how a parameter set of a simpleParameterized Object is constructed. Parameterized object “Y” has anassociation to its definition “X”, and is modified by “Z”. A call to amethod to retrieve on parameterized object “Y” (depicted as“GetParameters” in the example) results in the list of parameters asshown.

The Parameterized Object has the capability to construct a list ofparameter objects that are associated with it. The parameter list for aParameterized Object is composed from two sources: the parameters thatare inherited (including all overrides and modifiers, possibly n levelsup the parameter inheritance tree), and the parameters which have beendefined locally. FIG. 10 shows a instance model of the objects involvedin constructing a parameter list for a simple Parameterized Object.

Listed below are the steps that a Parameterized Object takes when it isasked for a list of its parameters. Take note of step 2, which causesrecursive behavior in that the inheritance tree is traversed all the wayto the root Parameterized Object. The root Parameterized Objectconstructs a parameter list, finishes all 5 steps outlined below, andthen returns that list to the next Parameterized Object down, and so,until the original calling Parameterized Object gets a list from steptwo. It then finishes steps 2, 3, 4, and 5 and the list is complete.

Step Action 1 The application asks for the parameter list of aParameterized Object. 2 If there is a definition object, traverse theinheritance tree in order to add its parameters to the list first (thiscontinues back to the root definition object). 3 If there are anyParameter Value and/or Override associations, then apply those to theirrespective inherited parameters in the parameter list. 4 If there areany Parameter Definition associations, then add those new parameters toparameter list. 5 If there are any Modifier Parameterized Objectassociations, then apply their Parameter Definition associations as ifthey were Parameter Override associations to their respective parametersin the parameter list.

1.1.3 Framework User Interfaces for Parameterized Objects

Two user interfaces are supplied by the Framework for working withParameterized Objects on a daily basis. The first user interfacesupplied by the Framework to manipulate Parameterized Objects is ageneric Parameter Definition Editor, which could appear as shown in FIG.11. The Parameter Definition Editor is an interface which allowsParameter Definitions to be created for a Parameterized Object. Thisinterface will most likely be utilized by someone with administrativeand/or supervisory capability.

FIG. 11 provides a depiction of the Parameter Definition Editor. TheFramework automatically provides the menu and toolbar services which theeditor may need, a tabbed tree pane (shown on the left side of thefigure), and a generic view pane which the application programmer canuse for just about anything—e.g., a graphical “canvas”, or a gridcontrol able to display data in a spreadsheet-like format.

The second user interface is a generic Parameter Property Sheetmechanism which is used whenever anyone needs to edit the Valueattribute of a parameter on any object. The property sheet can appear asFIG. 12. When the user double-clicks on a Parameterized Object, or insome other way activates an editing session on a Parameterized Object, aproperty sheet is created and displayed by the Framework. The individualproperty pages within the sheet correspond to each Parameter Group foundto be associated with the object being edited. Each page, in turn,displays only those parameters which have been associated to thecorresponding Parameter Group.

The current values of each parameter in the group are displayed,providing the user with the ability to change the values of configurableparameters, possibly creating Parameter Override objects. The“look-and-feel” of each parameter value displayed on the property pageis determined by the edit control type which was associated with thecorresponding Parameter Definition.

Some parameter values (such as an entire sequence block) requiresomething more sophisticated in order to edit it. In these cases, abutton containing an ellipses ( . . . ) appear next to the field, andwhen pressed, display the appropriate editor. In the event that aParameter value is derived from a user-specified formula, the formula isalso displayed, and allowed to be changed, on the property page.

1.2 Object Types

All configurable objects have an associated classification, or type,which they inherently belong to. An object's type is used to classifywhat it is, and is used primarily to segregate objects into groupings ofobjects exhibiting similar appearance and behavior (e.g., an AW70 andAW51, although both application workstations, have different physicalcharacteristics which necessitates distinguishing between them atconfiguration time. Thus, multiple instances of AW70's would each have aunique identifier in the configuration, but each would have a type ofAW70).

As used here and hereinafter, the symbols Awxxx, where xxx is a number,identifies an applications workstation available from the assigneehereof, The Foxboro Company, or other digital data processing apparatus.The term FBM or symbol FBMxxx, where xxx is a number, identifies a fielddevice available from The Foxboro Company, or other field device for usein process control. The term CP refers to a control processor or otherdigital data processing apparatus suited for that function.

The Framework provides methods to return an object's type to theapplication. This type information may be used for a number of reasons,including: preliminary lookup to see if two objects can establish aconnection; satisfy a search which uses a type filter; display of typeinformation on an object's placeholder.

The concept of type may be further abstracted into the concept of typecategory, which is a broader classification of type. Several objecttypes may belong to the same category (e.g. an AW70 and AW51 both belongthe category Application Workstation). All objects in the same categoryexhibit the same general behavior as that defined by that category. Forexample, an FBM would be an object type category, whereas an FBM02 andFBM04 are examples of specific object types.

Consequently, it is convenient to think of object types as beingcontained within a type hierarchy. Each branch in the hierarchy wouldcorrespond to an object type category, whereas the leaves, or endpoints,of each branch would correspond to specific object types. The remainderof this section will present the data model, with examples, of this typehierarchy for IDA.

1.2.1 Object Model

The object model used in the illustrated embodiment to support theconcept of object types is shown in FIG. 13.

1.2.1.1 IDA Type

This abstract base class is used only as a placeholder for containingdata and methods common to all “type-ish” classes. The only one shown inthe illustration is Object Type, but this can be expanded to includeother types such as Parameter Type, etc.

1.2.1.2 Object Type

An object's type is used to classify what it is—i.e., all objects of thesame type have the same appearance, and behave identically,differentiated only by minimal differences in associated data (e.g.name, ID, etc.) which is used to uniquely identify them.

The Object Type class is hierarchical—the branches of the hierarchyrepresent type categories, with the leaves, or endpoints, of thehierarchy being actual object types with which objects are associated.Instances of Object Types are Parameterized Objects, and may only bedirectly associated to a single type category (i.e., a specific objecttype cannot belong to more than one type category). Note, however, thateven though an object type can only be directly associated with one typecategory, it may indirectly be associated with several type categoriesdepending upon where it is in the type hierarchy. Every instance ofObject Type has a pointer back to its containing type category,regardless of whether it's acting as a simple object type, or a typecategory itself.

All instances in the Object Type hierarchy are able to act ascollections of Typed Objects. That is, each Object Type is able tomaintain a list of all Typed Objects which are directly associated withthe type itself. For example, all instances of an AIN block will containa pointer back to the AIN instance of Object Type. In turn, the AINinstance of Object Type will maintain a list of all instances of AINblocks in the configuration. This containment is meant to be only onelevel deep—in other words, there is no need for I/A Block, thecontaining instance of AIN, to also maintain a list of all AIN blocks(although nothing in the design would prevent it, if desired).

Additionally, each instance of the Object Type hierarchy which serves asa reference for a Typed Object requires a definition reference to thedefining Parameterized Object which defines that Typed Object. Thisrelationship provides quick access to the definition object when asymbolic representation of that definition is dragged and dropped into aview. For example, if the user clicks and drags an AOUT definition(either from the System Hierarchy, or from a library template) to aview, then drops it, this relationship provides access to theParameterized Object which actually defines an AOUT block so that it canbe created quickly.

Since an Object Type which can be referenced by a Typed Object requiresa reference to the defining Parameterized Object, only those instancesin the Object Type hierarchy be used to serve as the collection pointfor those same types of objects as they are created. If an Object Typedoesn't have a defining reference, is not a container of Typed Objects.

The Object Type class is an abstract class—no instances of Object Typemay exist in the database. Subclasses of Object Type are theimplementation-standard Object Type class, and the User-Defined ObjectType class. The Object Type class contains those methods common betweenthe two subclasses, e.g. methods used to support the hierarchicalrelationship(s) in the type hierarchy, the containment relationship toTyped Object class, and the reference to its associated definition TypeObject instance.

Summarizing Relationships:

-   -   An instance of an Object Type is directly associated with one,        and only one, other Object Type in the type hierarchy, and may        represent either a type category, or an actual object type,        depending upon where it resides in the hierarchy. For example,        in the hierarchy Module->FBM->FBM04, object types Module and FBM        represent type categories, and FBM04 represents an object type.    -   The Object Type class is an abstract class, and instances of        this class cannot exist. An instance of an Object Type is        preferably either a User-Defined Object Type, or a        implementation-standard Object Type.    -   The Object Type class is hierarchical, with branches        representing type categories, and leaves being object types. The        hierarchy is restrictive—that is, an implementation-standard        Object Type is preferably contained within a        implementation-standard hierarchy, whereas a User-Defined Object        Type can appear virtually anywhere in the hierarchy (but        ultimately also contained within a implementation-standard type        category).    -   Instances of the Object Type class contain a reference to their        containing type category.    -   Instances of the Object Type class which can serve as a        reference for a Typed Object maintain a list of all the Typed        Objects of that same type which exist in the configuration.    -   Those same instances of the Object Type class maintain a        reference to the Parameterized Object which is capable of acting        as the defining object for creating Typed Objects of that type.

FIG. 14 depicts an example of how the object type hierarchy can appearin IDA. As mentioned previously, within the type hierarchy, branchesform type categories, to which one or more object types belong. In theexample shown in FIG. 14 are all examples of type categories. Within thecategory Block Types, AIN Block, AOUT Block, and PID Block are examplesof implementation-standard object types, and User-X Block Types is anexample of a user-defined object type.

1.2.1.3 Implementation-Standard Object Type

All objects which can be typed inherently belong to one Object Type (ortype category)—that is the implementation-standard Object Type.Additionally, these objects may also optionally be associated with aUser-Defined Object Type.

Each instance of implementation-standard Object Type defined in thedatabase may be specified as the inherent type for one or moreconfiguration objects. All Implementation-standard Object Types have adirect association with a type category, which is preferably also beImplementation-standard. In other words, a Implementation-standardObject Type may not be associated with a user-defined type category.

All Implementation-standard Object Types have three additionalattributes—they are: configurable—all instances of this object type areable to be configured in an I/A configuration; assignable—all instancesof this object type are able to be assigned to a process area; anddownloadable—able to be realized (as an entity) on a target platform.Whether an object type is configurable, assignable and/or downloadableis determined at the time the instance of the Implementation-standardObject Type is created.

Summarizing Relationships:

-   -   The Implementation-standard Object Type class is a subclass of        Object Type.    -   An instance of a Implementation-standard Object Type is        inherently associated with one or more instances of Typed Object        (e.g., there can be many instances of an FBM04 in the        configuration).    -   An instance of a Implementation-standard Object Type preferably        belongs to a type category which is in the        Implementation-standard Object Type hierarchy. In other words,        going back along the type hierarchy chain from a        Implementation-standard Object Type, one would only find        Implementation-standard type categories.    -   When created, an instance of a Implementation-standard Object        Type may be designated as needing to appear in the system        hierarchy.

1.2.1.4 User-Defined Object Type

Users may create their own, customized object types, which may beassigned to typed objects. The primary purpose of a User-Defined ObjectType is to allow the user to create their own object classificationsystem in the event that the set Implementation-standard Object Typesdoesn't satisfy all their needs.

Summarizing Relationships:

-   -   The User-Defined Object Type class is a subclass of Object Type.    -   An instance of a User-Defined Object Type may be associated with        one or more instances of Typed Object (e.g., there can be many        instances of User X Block Type I in the configuration). This        relationship is strictly optional, and User-Defined Object Types        may exist without ever having been referenced by an object.    -   An instance of a User-Defined Object Type may appear anywhere in        the type hierarchy. In other words, a User-Defined Object Type        may be directly associated with either a        Implementation-standard, or user-defined, type category.    -   When created, an instance of a User-Defined Object Type may be        designated as needing to appear in the system hierarchy.

1.2.1.5 Typed Object

A Typed Object is a Parameterized Object which is able to be insertedinto an I/A configuration, and is considered an integral part of theconfiguration, in such a way that the configuration would be consideredincomplete without it. Examples of typed objects include CPs, FBMs,blocks, loops, and compounds. Objects such as graphical objects used toenhance documentation would not be considered Typed Objects.

Typed objects inherently have an associated Implementation-standardobject type. The fact that an object is configurable is determined bywhether or not its inherent object type is or not. Typed Objects mayalso have a User-Defined Object Type associated with them, although thisrelationship is optional.

One further restriction: at creation, a Typed Object is prevented fromassociating with an Object Type (and thereby prevented from beingcreated), unless that Object Type also references an associated definingParameterized Object which acts as the definition for the Typed Objectbeing created. In an alternate embodiment, when a Typed Object iscreated and a reference made to its associated Object Type, if thatObject Type doesn't have a reference to the defining ParameterizedObject, it simply uses the one from the Typed Object itself.

Summarizing Relationships:

-   -   The Typed Object is a subclass of Parameterized Object.    -   An instance of a Typed Object has an inherent        Implementation-standard Object Type associated with it, which        the user cannot modify, or change. This object type determines        whether or not the Parameterized Object is configurable,        assignable to a process area, and/or downloadable to a target        system.    -   An instance of a Typed Object may have an optional User-Defined        Object Type associated with it. This association is in addition        to the Implementation-standard Object Type.

There may be occasions where it would be desirable to change the type ofan object, without having to delete the original object, then create anobject of the correct type. One example of where this capability couldbe useful would be being able to change a station type after aconfiguration has already been created, and all associations andconnections established (this happens often). An alternate embodimentaccordingly, permits the type of an object to be dynamically charged.

1.2.1.6 Configuration

The Configuration class exists to serve as an entry point into the twoprimary hierarchies which comprise the configuration itself—the SystemHierarchy, and the Plant Hierarchy. These two hierarchies are, however,by no means mutually exclusive. The primary method(s) and dataincorporated in this class exist to serve the establishment andmaintenance of hierarchical relationships. Other configuration-wide dataand/or methods may also reside with this class.

1.2.1.7 System Hierarchy

The System Hierarchy represents those objects which are contained withinthe configuration, and are organized by various categories, primarilyobject type. There are potentially several subclasses of SystemHierarchy objects in the System Hierarchy itself. However, for presentpurposes, only two of these subclasses are discussed:

-   -   Definition Hierarchy. This portion of the System Hierarchy deals        with the display of definition objects, or those objects which        act to define other Typed Objects (e.g., an AIN block        definition). Within the Definition Hierarchy, definition objects        may be organized in a number of libraries. These libraries are        either implementation-standard or defined by the user.    -   Components Hierarchy. This portion of the System Hierarchy deals        with the display of actual instances of configured objects, and        may not, themselves, act as definition objects.

All other subclasses within the System Hierarchy simply representanother view of existing configuration components. For example, aNetwork Hierarchy could display a view of the configuration from aSystem Definition point of view, showing a hierarchy of networks, nodes,stations, FBMs and other hardware. Since the only grouping ofconfiguration objects in the current design is by object type, thesesubclasses have to use the relationships specified in the Connectionsdiscussion in order to know what to display (i.e., by network, bylocation, etc.).

The primary reason that subclasses exist within the System Hierarchy isdue to the differences in behavior when dealing with objects in eachsubclass. For example, the act of dragging and dropping an object fromthe definition portion of the System Hierarchy results in the creationof a Typed Object of the proper type, whereas when an object from thecomponents portion of the System Hierarchy is dragged and dropped, itresults in that object being copied and placed in the view, or connectedto another object, depending upon where it was dropped.

The visible portion of the System Hierarchy tree control actuallyconsists of two types of elements: actual instances of System Hierarchyobjects (of which there are very few), and derived (non-persistent)instances of tree control objects. Actual instances of the SystemHierarchy may reference one or more instances in the Object TypeHierarchy. This relationship provides the mechanism by which themajority of the visible System Hierarchy is constructed dynamically aselements are “exploded” by the user in the tree control.

1.2.1.8 Plant Hierarchy

The Plant Hierarchy also represents those objects which are containedwithin the configuration, but are organized by location, rather than bytype. This hierarchy represents another view of already-existingconfiguration components, and may be constructed using a subclass ofSystem Hierarchy.

1.2.2 Managing Object Types

The user can create a new instance of an Object Type by selecting “New”on a pulldown menu within the definition portion of the SystemHierarchy. Alternatively, a “New|Object Type” menu selection isavailable on any IDA application. However the user chooses to performthis task, the action can result in the display of a dialog box similarto that in FIG. 15. In this example, the user enters the new ObjectType, and provides a description for the new type. Additionally, theuser picks an already existing object type in the type hierarchy to actas its “template” type, or object type to be used to create from. Theuser can create a new object type from an existing one in two ways:

-   -   Copy. In this create method, the new object type is created by        copying the existing object type, and is instantiated in the        type hierarchy at the same level as the object type which was        copied.    -   Derive. In this create method, the new object type is created by        using an existing object type as its parent, thereby treating        the old object type as a type category.

In order to finish creating the new object type, the user additionallyspecifies such things as:

-   -   Configurable. Specifies whether or not all objects associated        with this object type are able to be configured in terms of        security (i.e., a user's access to an object is determined by        the user's group access to the object's type). If an object type        is not configurable, objects created which are associated with        that object type will not be affected by security mechanisms.    -   Downloadable. Specifies whether or not all objects associated        with this object type are downloadable to a hardware target.        Note that this option will be dimmed, and not available for        selection if the object type being described is a User-Defined        object type.    -   Assignable to System Hierarchy. Determines whether or not an        object is visible within the System Hierarchy when the hierarchy        is viewed from the tree control.    -   Assignable to Process Area. Determines whether or not an object        associated with this object type can be assigned to a process        area.

To edit an existing instance of an Object Type, a dialog similar to theone shown in FIG. 15 is displayed, already populated with theinformation dealing with this object type (i.e., the configurable,assignable and/or downloadable flags checkboxes are selectedappropriately). When an object type is edited, the only things that canbe changed are the object's description, and whether or not the objectis configurable, assignable and/or downloadable. Some of the attributeand assignable selections may be disabled when the object type isdisplayed, depending upon the settings of the object type's containingcategory.

To delete an instance of an Object Type in the hierarchy, the user mustpreferably explicitly decide to remove it. If the object being deletedis a type category, the user is informed, and asked if they wish tocontinue—if they confirm the delete, then everything in the typehierarchy from the object type downward is removed.

1.3 Parameterized Object Connections

An IDA configuration consists not only of objects, but objects which arerelated to each other in a number of ways. These relationships may bephysical (e.g. a serial connection between a serial printer and astation) or logical (e.g. a host relationship between an AP and a CP, ora collection point relationship between a block and an historian). Theserelationships are all called connections.

Establishing a connection actually requires two different levels of“hand-shaking” between the two objects involved. Consequently, thesubject of connectivity is divided into two sections:

-   -   1. The first level represents the connectivity which is        established between two objects. Although easy to envision (e.g.        the connection between a block and a compound), there is no        actual database association which is actually created at the        object level.    -   2. The second level represents the connectivity which is        established between two parameters. The database association is        established at this level, and is the mechanism by which two        objects establish a relationship.

1.3.1 Type Awareness

Any Parameterized Object in IDA has an inherent Implementation-standardobject type. This object type, in turn, has a direct relationship to asingle type category, but may be indirectly related to several typecategories.

In FIG. 16, an instance of an AW70X (with control) knows that it's anAW70X, by virtue of the fact that AW70X is its inherentImplementation-standard object type. However, the instance is preferablyalso “aware” that it is also an AW70, NT Application Workstation, orcontrol processor (here, identified as a “Z-Module,” in reference to acontrol processor available from the assignee hereof, The FoxboroCompany), going backward through the type hierarchy. This awareness maybe used in a number of ways, particularly when a process is dealing withthe concept of object types at different granularities. For instance,when dragging a specific serial printer across a representation of theAW70X mentioned above, the printer may not “know” that it can connect toan AW70X, but it may know that it could establish a connection to an NTApplication Workstation. The Framework provides methods for allowing theapplication developer to “walk” the type hierarchy tree in order toobtain the direct, and all the indirect, type categories which aspecific object type is related to.

1.3.2 Source/Sink vs. Parent/Child Relationships

A connection in IDA can describe a Source/Sink, or Parent/Childrelationship between two objects. There are very subtle differences inthe two types of relationships, but they are different enough to warrantseparation of behavior. A Parent/Child relationship is typically used tomodel the relationship between two objects in a hierarchical, orcontainment relationship whereas a Source/Sink relationship is usuallyused in a peer-to-peer type of relationship. These differences arepresented in the table below:

Relation Data Data Description Parent Capacity Data represents themaximum combined “weight” of the children which can be associated tothat object. Child Weight Data represents the weight of a singleinstance of the child object. Source Min, Max Specifies the minimum andmaximum number of connections to other objects, or sinks, which can besupported by that object. Supports the concept of a “fan-out”capability. Sink Min, Max Specifies the minimum and maximum number ofconnections from other objects, or sources, which can be supported bythat object. Supports the concept of a “fan-in” capability.

An example of a Parent/Child type relationship would be that of a CP toits connected FBMs. The CP acts as a parent in that it acts as a commoncontrol connection for all the FBMs which are physically connected toit. The CP is able to support a certain number of FBMs. Each FBM, inturn, acts as a child in that it relies on the CP to perform certainduties, and it contributes a specific weight toward the total capacitysupported by the CP.

In both Parent/Child and Source/Sink connections, the concept of fan-inand fan-out is valid. A fan-out connection can be used to model arelationship in which the source (parent) object supports connections toone or more sinks (children) objects in the database. One example ofsuch a connection type is a output (or “PNT”) parameter on an AIN blockand its associated output signal flows. The PNT parameter, acting as asource, would provide measurement values to one or more input parameters(conventionally referred as “MEAS” or “SPT”) in other blocks, each inputparameter acting as a sink.

1.3.3 Connection Object Model

FIG. 17 depicts the classes used in the illustrated embodiment tosupport connectivity at the object level. This shows the model used tosupport a source (parent) Parameterized Object, connecting to the sink(child) Parameterized Object. The model is not intended to suggest thattwo connectable parameters of the same object can't be connectedtogether (i.e., the same Parameterized Object can be both source andsink at the same time). An example of when this might occur is acalculation output parameter (conventionally referred to as “BCALCO”)parameter acting as calculation input parameter (conventionally referredto as “BCALCI”) parameter in the same I/A block.

One aspect of the object model needs to be explained in order tounderstand it fully. When a Parameterized Object is created, noParameter Override or Endpoint objects exist. The Override and Endpointobjects only get created whenever a Connection is about to beestablished. When a Connection is about to be established, theappropriate Parameter Override object and Endpoint object areinstantiated, and as depicted in FIG. 18, these two objects eachmaintain a reference to their associated parameterized object, as wellas to each other, allowing iteration over an object's connections fromeither direction.

1.3.3.1 Connection

A Connection contains the data and methods that defines a relationship,or link, between two Parameterized Objects (or more specifically,between two connectable parameters). In an I/A relationship, aconnection could can be used to model the logical relationship betweentwo blocks, or the host relationship between two stations, etc.

In order to take into account the complex relationships that aConnection can have with other classes (esp. Placeholder classes), aConnection is a Parameterized Object. This allows Connections to beprimarily data driven, rather than compiled behavior, allowing theestablishment of connections with new objects to be done in an easierfashion. For example, some Connections probably are not displayed in agraphical environment (such as the relationship between an historian andits associated historizable points). Whether or not to display aConnection is, preferably, parameter-driven.

A Connection in IDA can be a Parent/Child relationship, or aSource/Sink. In order to exist, a Connection preferably has exactly oneSource (or Parent) Endpoint, and one Sink (or Child) Endpoint. However,the two endpoints may exist without a Connection having yet beenestablished between them. As mentioned previously, the endpoints of theConnection will not be instantiated until the Connection itself is aboutto be established. Conversely, endpoint objects remain persistent evenafter the associated Connection has been removed.

Graphically, connections between two objects will be connected at theedge of the rectangular area representing each object. The system willalso support connections connected to a point at the center of theobject as well. Connections are represented by segmented polylines madeup of alternating horizontal and vertical segments. The system alsosupports single segment lines representing an association.

Summarizing relationships: a Connection is a Parameterized Object; aConnection, if it exists, preferably has both a Source (or Parent) and aSink (or Child) Endpoint. Note, however, that certain operations (e.g.selection state) deal with the Association, and only one (or none) ofits associated Endpoints; a Connection has a relationship to anAssociation Placeholder.

1.3.3.2 Connection Endpoint

A Connection Endpoint is an abstract class from which all connectionendpoints are derived. No instances of this class may exist bythemselves. The Connection Endpoint contains a reference to theParameter Override which is either the source (parent) or sink (child)parameter representing one end of a connection.

Connection Endpoints provide a mechanism for associating the connectionto the object. The endpoints relate the Connection to the ParameterOverride to (or from) which the Connection is attached. Endpoints alsorelate the Connection to the position (side/direction, or center) wherethe Connection is attached to the object. Each Connection Endpoint isdescribed by two coordinates, the side of the object it is on, and therelative position of the endpoint along the side of the rectanglerepresenting the parameterized object. This allows the endpoint toretain its relative position along the side, even if the object isresized.

Connection Endpoints only come into existence whenever a connectionbetween any two objects (or parameters) is about to be established. Oncethe Framework approves the creation of the connection, it instantiatesthe endpoint class instances, along the associated parameter overrides,inserting a reference to the parameterized object in each.

Connection Endpoints have a direct relationship to a Point Placeholder,allowing a depiction of the endpoint itself to be displayed on thescreen.

Summarizing Relationships:

-   -   The Connection Endpoint class is an abstract class, and no        instances of it may exist in IDA. This class is further        specialized into Source/Sink Endpoints, and Sink/Child        Endpoints.    -   Each instance of a Connection Endpoint has a reference to a        Point Placeholder.

1.3.3.3 Source/Parent Endpoint

A Source (or Parent) Endpoint is the endpoint which is specific to thesource (or parent) end of the Connection between two ParameterizedObjects, and is a simple sub-class of the abstract Connection Endpointclass. The Parameterized Object maintains a list of its Source/ParentEndpoints. The Source/Parent Endpoint can be the source of severalconnections, supporting “fan-out” connectivity. The Source/ParentEndpoint may exist without a Connection to a Sink/Child Endpoint.

Summarizing Relationships:

-   -   An instance of a Source/Parent Endpoint is associated with one,        and only one, Parameterized Object. The Parameterized Object, in        turn, maintains a list of all Source/Parent Endpoints associated        with it.    -   Each instance of a Source/Parent Endpoint may be associated with        one or more Connections. This supports the concept of a        “fan-out” relationship, which is valid for both Parent/Child as        well as Source/Sink type relationships.    -   Each instance of a Source/Parent Endpoint is directly related to        the connectable Parameter Override it represents.

The Endpoint object can support the concept of a reference counter,which represents the number of connections currently associated with it.

1.3.3.4 Sink/Child Endpoint

A Sink (or Child) Endpoint is the endpoint which is specific to the sink(or child) end of the Connection between two Parameterized Objects, andis a simple sub-class of the abstract Connection Endpoint class. TheParameterized Object maintains a list of its Sink/Child Endpoints.

The Sink/Child Endpoint may only be the sink (child) of a singleconnection. The Sink/Child Endpoint may exist without a Connection to aSource/Parent Endpoint.

Summarizing Relationships:

-   -   A instance of a Sink/Child Endpoint is associated with one, and        only one, Parameterized Object. The Parameterized Object, in        turn, maintains a list of all Sink/Child Endpoints associated        with it.    -   Each instance of a Sink/Child Endpoint may be associated with        only one Connection.    -   Each instance of a Sink/Child Endpoint is directly related to        the connectable Parameter Override it represents.

1.3.4 Object Connection Type Object Model

FIG. 19 depicts additional classes used in the illustrated embodiment tosupport connectivity at the object level.

1.3.4.1 Object Connection Type Specifier

The primary function of the Object Connection Type Specifier is toprovide a list of Object Types to Parameterized Objects, allowingobjects to be “extended” such that they encapsulate the behavior of anobject in terms of being a parent/child, or source/sink. The ObjectConnection Type Specifier is an abstract class from which four basicobject connection type specifiers are derived: parent, child, source andsink.

Each Object Connection Type Specifier is directly related to aParameterized Object, and is used to help determine the nature ofconnectivity that the Parameterized Object is allowed to participate in.The same Parameterized Object can act simultaneously as a parent (orsource) and a child (or sink). This gives rise to the one-to-manyrelationship between Parameterized Object and Object Connection TypeSpecifier shown in the model

In the example shown in FIG. 20, an Historian acts as a parent to allhistorized points associated with it, yet simultaneously acts as a childwhen discussed in terms of being associated with a software host. Asused herein and throughout, a “historian” is a block or otherfunctionality used to track parameter values during runtime operation ofa process control system configured in accord with the teachings hereof.Each parameter so tracked is referred to as a “point,” a “historizedpoint,” or the like. In the illustrated embodiment, the object type fora Historian is the same, no matter how many Object Connection TypeSpecifiers a Parameterized Object may be associated with.

Summarizing Relationships:

-   -   The Object Connection Type Specifier class is used to relate        instances of Parameterized Objects with Object Types    -   Each instance of an Object Connection Type Specifier subclass is        directly related to the Object Type it represents. The same        Object Type may be associated with one or more Object Connection        Type Specifiers.    -   Each instance of an Object Connection Type Specifier subclass is        directly related to the Parameterized Object it represents. It        is possible for the same Parameterized Object to be associated        with more than one Object Connection Type Specifier.    -   Each instance of an Object Connection Type Specifier is        referenced in one or more instances of the Object Connection        Type class, with the added sense of whether or not the        referenced specifier represents a source/parent, vs. sink/child        in a potential connection.

1.3.4.2 Parent Object Connection Type Specifier

Parent Object Connection Type Specifiers extend the abstract ObjectConnection Type Specifier class to handle object types capable offulfilling a parent role when connecting to another object. As such,they specify the capacity, or total weight, of all the child objectswhich they are capable of supporting, and provide other functionalityused by a parent object.

Examples of a Parent Object Connection Type Specifier would include a CPwhich has the capacity to support 48 FBMs in an I/A fieldbusrelationship, an AP which allows two serial printers to be connected viaa serial connection, or an historian able to support 4000 collectionpoints.

In a preferred embodiment, any object capable of playing a parent rolekeeps track of the total “weight” of the connections which have beenestablished for each connection type it is able to support. This valuecan be associated with the parameter associated with the endpoint of aconnection.

1.3.4.3 Child Object Connection Type Specifier

Child Object Connection Type Specifiers extend the abstract ObjectConnection Type Specifier class to handle object types capable offulfilling a child role when connecting to another object. As such, theyspecify their weight which they will contribute to the totalaccumulative weight when connecting to a parent. Examples of ChildObject Connection Type Specifiers include an FBM connecting to a CP, ora serial printer connected to an AP. Each connection causes the totalaccumulative weight for that connection type to be incremented by thechild's weight. Prior to actually establishing a connection, theFramework checks to ensure that the weight supported by the parentobject does not exceed its capacity for that connection type. If itdoes, the connection attempt will fail, and the application program willbe informed that the pending connection is no longer feasible.

1.3.4.4 Parent/Child Object Connection Type Specifier Examples

The table below illustrates the data which needs to be considered at theobject level for each valid parent/child connection—namely:

-   -   Capacity (This value specifies the total weight which the parent        object type is able to support for the associated connection        type); and    -   Weight (This value specifies the amount of capacity consumed        whenever a child object of this type is attached to the parent).

Parent Connection Object Type Capacity Type Child Object Type WeightHistorian 4000 Historian Historizable Point 1 CP40 48 Fieldbus FBM 1AW70 2 Serial Serial Printer 1 IE32 4 Nest 1 × 8Cell 1 AP51 unlimitedSoftware Host CP40 1

1.3.4.5 Source Object Connection Type Specifier

Source Object Connection Type Specifiers extends the abstract ObjectConnection Type Specifier class to handle object types capable offulfilling a source role when connecting to another object. There are noadditional data or methods beyond those provided by the ObjectConnection Type Specifier class. This subclass provides consistency andflexibility during implementation.

1.3.4.6 Sink Object Connection Type Specifier

A Sink Object Connection Type Specifier extends the abstract ObjectConnection Type Specifier class to handle object types capable offulfilling a sink role when connecting to another object. There are noadditional data or methods beyond those provided by the ObjectConnection Type Specifier class. The subclass provides consistency andflexibility during implementation.

1.3.4.7 Source/Sink Object Connection Type Specifier Examples

The table below illustrates the data which needs to be considered at theobject level for each valid source/sink connection.

Source Object Type Connection Type Sink Object Type AIN Block ConnectionPID PID Block Connection AOUT

1.3.4.8 Object Connection Type

Instances of the Object Connection Type class provide a means ofestablishing the outermost layer of connectivity between any twoobjects. This class is used to describe the “legal” combinations ofobject types or type categories (i.e., Source/Sink vs. Parent/Child)which are able to form a connection. These connections can be physical(e.g. an electrical signal flow between a serial port and a serialdevice) or logical (e.g. a host relationship between an AP and a CP, ora collection point association between a block and an historian).

There are two relationships that each instance of an Object ConnectionType has with the Object Connection Type Specifier class—one is used tospecify the source (parent) type, and the other is to specify the sink(child) type. In this way, the Object Connection Type class acts as ajoin table, relating two object types to determine whether there is apotential connection possible. This class is therefore used as aninitial “filter” to determine whether two objects are able to establisha connection before the more complex negotiation between two parametersis allowed to continue.

When examining instances of the Object Connection Type class to see iftwo object types can form a valid connection, the Framework mayencounter more than one instance which satisfies the criteria. If thisoccurs, the user will have to manually resolve the ambiguity, and selectthe connection type being sought.

While making a determination as to whether two object types can connecttogether or not, the Framework takes into account the fact thatinstances of Object Connection Types may not go all the way “down” tothe object type level, but may specify type categories instead. In thismanner, for example, a specific type of serial printer could bespecified as being able to be connected to all NT applicationworkstations, rather than specific types of NT stations. The Frameworktakes into account type “awareness”, which was discussed in a previoussection, in order to accomplish this.

Summarizing Relationships:

-   -   Each instance derived from an Object Connection Type contains        references to two Object Types—one for a Source (Parent) Object        Type, the other for a Sink (Child) Object Type. These object        types are paired together to determine whether a request to        connect two objects together is “legal”, or valid, depending        upon what types of objects they are.    -   The Object Connection Type class contains methods which, when        given two object types, allows the application developer to        determine which object type is acting as the source (parent)        object, and which one is acting as the sink (child) object.

In order to efficiently implement type “awareness”, a bitmaskingoperation can be used, in which each unique type category, as well asobject type, gets assigned a unique bitmask value. By “or'ing” all ofthe bitmasks together of all the type categories which an object belongsto, the matter of comparing an object's type bitnask with that of thetypes contained in each instance of the Object Connection Type classbecomes a single operation, rather than a series of string compares.

1.3.5 Parameter Connection Type Object Model

FIG. 21 depicts the classes used in the illustrated embodiment tosupport connectivity at the parameter level. Note that the classstructure presented in FIG. 21 closely parallels that of the objectconnection type object model presented in FIG. 19.

1.3.5.1 Parameter Type

The Parameter Type class is just that—a class used to describe all thevarious types of connectable parameters which can exist in I/A. Examplesof Parameter Types includes serial ports, serial devices, analog input,analog output, historian hosts, and historizable points. Any“connectable” parameter in I/A preferably has an associated ParameterType. Summarizing relationships:

-   -   A Parameter Type is a base class providing I/A with types of        connectable parameters. No parameters will be allowed to be        related to an endpoint in a Connection unless it is also        represented by a Parameter Type found in an instance of this        class.    -   Each Parameter Type may be associated with one or more Parameter        Connection Type Specifiers, which provide additional information        regarding connectability for that specific Parameter Type.

The Parameter Type class can be implemented as another type category inthe Object Type hierarchy. In this manner, any code developed to dealwith object types (esp. if implementing bitmask operations) may also beused to deal with parameter types.

1.3.5.2 Parameter Connection Type Specifier

The primary function of the Parameter Connection Type Specifier is toprovide a list of Parameter Types to Parameter Definitions, and tofine-tune the “connectable-ness” of that Parameter Definition with theconnection. The Parameter Connection Type Specifier class is an abstractclass, from which four basic parameter connection type specifiers arederived: parent, child, source and sink.

Each Parameter Connection Type Specifier is directly related to one ormore connectable Parameter Definitions, and is ultimately used todescribe the nature of connection that the parameter is allowed toparticipate in. The parameter to act simultaneously as a parent/source,and a child/sink, thus the one to many relationship between ParameterOverride and Parameter Connection Type Specifier.

In the example shown in FIG. 22, a MEAS parameter override acts as asource for other input parameters (e.g., a MEAS parameter in a REALMblock), yet simultaneously acts as the sink when connected to aparameter such as a PNT parameter in an AIN block. Note that theparameter type “MEAS” is the same, no matter how many ParameterConnection Type Specifiers a parameter override may be associated with.

Summarizing Relationships:

-   -   The Parameter Connection Type Specifier class is used to relate        instance of Parameter Overrides with Parameter Types.    -   Each instance of a Parameter Connection Type Specifier subclass        is directly related to the Parameter Type it represents. The        same Parameter Type may be associated with one or more Parameter        Connection Type Specifiers.    -   Each instance of a Parameter Connection Type Specifier subclass        is directly related to the Parameter Override it represents. It        is possible for the same Parameter Override to be associated        with more than one Parameter Connection Type Specifier.    -   Each instance of a Parameter Type Specifier is referenced in one        or more instances of the Parameter Connection Type class, with        the added sense of whether or note the referenced specifier        represent a source/parent, vs. sink/child in a potential        connection.

1.3.5.3 Parent Parameter Connection Type Specifier

Parent Parameter Connection Type Specifiers extends the abstractParameter Connection Type Specifier class to handle parameters capableof fulfilling a parent role when connecting to another object. There areno additional data or methods beyond those provided by the ParameterConnection Type Specifier class. The subclass provides consistency andflexibility during implementation.

1.3.5.4 Child Parameter Connection Type Specifier

Child Parameter Connection Type Specifiers extends the abstractParameter Connection Type Specifier class to handle parameters capableof fulfilling a child role when connecting to another object. There areno additional data or methods beyond those provided by the ParameterConnection Type Specifier class. The subclass provides consistency andflexibility during implementation.

1.3.5.5 Parent/Child Parameter Connection Type Specifier Examples

The table below presents some examples that have a parent/childrelationship.

Parent Parameter Type Connection Type Child Parameter Type Serial PortSerial Connection Serial Device Historian Logical Historian HistorizablePoint Parallel Port Parallel Connection Parallel Device

1.3.5.6 Source Parameter Connection Type Specifier

Source Parameter Connection Type Specifiers extend the abstractParameter Connection Type Specifier class to handle source-typeendpoints of a connection. As such, they will specify the minimum andmaximum number of sinks with which they are able to establish aConnection. Examples of a Source Parameter Connection Type Specifierwould be an I/O point in I/A, represented by the PNT parameter in a AINblock. The PNT parameter acts as the source for signals flowing to oneor more input parameters.

1.3.5.7 Sink Parameter Connection Type Specifier

Sink Parameter Connection Type Specifiers extend the abstract ParameterConnection Type Specifier class to handle sink-type endpoints of anassociation. As such, they will specify the minimum and maximum numberof sources with which they are able to establish a connection. Anexample in I/A of a Sink Parameter Connection Type Specifier would be aMEAS or SPT parameter in a PID block, either of which is able to receivesignal input from another block.

1.3.5.8 Source/Sink Parameter Type Specifier Examples

The table below presents some examples which that have a source/sinkrelationship.

Source Sink Parm Parm Type Min/Max Connection Type Min/Max PNT1/unlimited Block Connection MEAS 1/1 PNT 1/unlimited Block ConnectionSPT 0/1 BCALCO 1/1 Block Connection BCALCI 0/1

The “Min” data associated with a Sink represents an optional/requiredfeature, with a zero (0) representing an optional connection, and a one(1) representing a required connection.

1.3.5.9 Parameter Connection Type

Instances of the Parameter Connection Type class represent the innermostlayer of associativity between any two objects. This class is used todescribe the “legal” combinations of parameter types which are able toform a connection. These connections can be physical (e.g. an electricalsignal flow a serial port and a serial device) or logical (e.g. acollection point connection between a MEAS parameter and an historian).

There are two relationships that each instance of a Parameter ConnectionType has with the Parameter Connection Type Specifier class—one is usedto specify the source (parent) type, and the other is to specify thesink (child) type. In this way, the Parameter Connection Type class actsas a join table, relating two parameter types together to determine theconnection endpoints. This class is therefore used as the final “filter”to determine whether two objects are able to establish a connection.

1.3.6 Establishing a Connection

The listing below represents the sequence of events which preferablyoccur before a Connection can be made between two parameters. This logicis used when an object is being “dragged” around the view, looking for adrop target. Additionally, this logic is valid whether the object beingdragged is a potential Source/Parent in a relationship, or Sink/Child.

Level 1—Object to Object

Step Action Performed 1 Click and begin “dragging” object in view -cursor changes to a drag cursor. 2 Using the Object Connection TypeSpecifier of each object, check to see if there is any instances of thecorrect pairing in Object Connection Types. 3 If an instance in ObjectConnection Types is found, then change cursor to indicate that the droptarget is potentially valid, otherwise perform no action. If valid,retain the sense of which object is now acting as Source(Parent), andwhich one is acting as the Sink(Child), as well as the type ofConnection being sought.

-   -   If no instance is found, then cursor remains unchanged, and the        user will not be allowed to drop the object.

Level 2—Parameter to Parameter (Perform Only if Level 1 Above Passed)

Step Action Performed 4 Iterate through instances of the ParameterConnection Type class to find the proper Source (Parent) and Sink(Child)parameter types necessary to fulfill this connection. Note that theremay potentially be several instances of the Parameter Connection Typeclass which satisfy the conditions imposed by the connection - keeptrack of all of them since we're not sure yet what parameters theobjects have. 5 For the Source(Parent) object, find the proper ParameterDefinition based on the Source(Parent) parameter type found in step (4)above. 6 Perform the same action for the Sink(Child) object parameterdefinition using the Sink(Child) parameter type which was paired withthe Source(Parent) parameter type used in step (5) above. 7 Create theappropriate Parameter Override(s) with their associated Source(Parent)and Sink(Child) Endpoints (note that they may already exist fromprevious connection). 8. Create the instance of the Connection. If morethan one connection is permissible, a preferred or default connection isautomatically selected.

The final responsibility for establishing a connection between twoobjects rests with the methods responsible for negotiating the“handshake” between the two parameters. These methods check for adequatecapacity on the source(parent) object, and establish the actualconnection instance itself. This code resides with the source object orthe sink object.

Parameter-level connections can be automatically established asdescribed in steps 4-8 above. In addition, they can be established viadirect operator intervention. Through a drag-and-drop operation, menuselection or otherwise, the operator identifies two parameters betweenwhich a connection is to be established. After verifying that arelationship can exist between the objects themselves (e.g., asdescribed in steps 1-3, above), the Parameter Connection Type Specifieris checked to insure that the combination is permissible. If so, thenecessary Parameter Overrides are created.

In some embodiments, the creation of certain connections betweenparameters causes other to be automatically established. These arereferred to as master and slave connections (or “connectionpropagation”). By way of example, once a connection is establishedbetween the PNT parameter of an AIN object and the MEAS input parameterof a PID object, related (or “slave”) connections are made betweenrelated parameter pairs (e.g., low and high scale parameters) of theseobjects. These slave connections can be modified by the operator, asdesired. Slave connections are automatically updated or destroyed whenthe corresponding master connection is updated or destroyed. Thus, forexample, the destruction of a connection between the PNT parameter of anAIN object and the MEAS input parameter of a PID object automaticallyresults in destruction of low-scale, high-scale and otherparameter-level slave connections between these objects.

1.3.7 Connectivity Examples 1.3.7.1 Parent/Child Connectivity—Case #1

FIG. 23 depicts the connections between an Historian to all thehistorizable points which have been assigned to it. The following tabledepicts the connectivity data needed to support these connections at theobject level:

Parent Child Object Object Type Capacity Connection Type Type WeightHISTORIAN 4000 Historian Connection AIN Block 1 HISTORIAN 4000 HistorianConnection PID Block 1whereas this table depicts the connectivity data need to support theseconnections at the parameter level:

Parent Parameter Type Connection Type Child Parameter Type HISTORIANHistorian Connection PNT HISTORIAN Historian Connection MEAS

This example depicts how data can be structured to handle theparent/child situation where the child does not need to have a sense ofwhich point it is (e.g., the MEAS parameter doesn't need to know it'sthe 2nd historized point in this example), simply that it's connectedthe HIST parameter of the historian. This example also provides themeans to establish a “fan-out” relationship for a parent/childconnection.

1.3.7.2 Parent/Child Connectivity—Case #2

FIG. 24 is similar to the first, except that now the ParameterDefinitions have been provided in such a way so as to “split” theparameter representing two serial ports into two separate parameters,each parameter representing a single serial port. The following tabledepicts the connectivity data needed to support these connections at theobject level:

Parent Child Object Object Type Capacity Connection Type Type WeightAW70A 2 Serial Connection BW132 1 (NT Station) (Serial Printer) AW70A 2Serial Connection BW80 1 (NT Station) (Serial Printer)

Whereas the following table depicts the connectivity data need tosupport these connections at the parameter level:

Parent Parameter Type Connection Type Child Parameter Type Serial Port 1Serial Connection Serial Serial Port 2 Serial Connection Serial

This example depicts how data is structured to handle the parent/childsituation where the child has to “know”, or be aware of, the specificparent parameter instance they are connected to. In other words, in thisscenario, it's important to know that Printer #1 is connected to SerialPort 1, and that Printer #2 is connected to Serial Port 2. If this levelof detail is unimportant, then the parameter definitions for the AW70could be modeled in such as way that there was only one Serial Portparameter, and one endpoint object, to which all serial devices wouldconnect.

1.3.7.3 Parent/Child Connectivity(Nest)—Case #3

FIG. 25 depicts how a nest can be implemented within IDA. The followingtable depicts the connectivity data needed to support these connectionsat the object level:

Parent Child Object Object Type Capacity Connection Type Type WeightIE32 4 Nest Connection 1 × 8 CELL 1 (Enclosure) (Cell) 1 × 8 CELL 8 NestConnection FBM04 (FBM) 1 (Cell)

The following table depicts the connectivity data need to support theseconnections at the parameter level:

Parent Parameter Type Connection Type Child Parameter Type CellSlot NestConnection Cell ModuleSlot Nest Connection Module

This example depicts how data can be structured to handle theparent/child connections used to support a multilevel nesting scenario.This implementation takes into account that each object connecting toits parent needs to know which “slot” it occupies, and in turn, each“slot” needs to know what object is currently occupying it (if any).

This design allows object differentiation between the slots. Forexample, it is easy to model (in the parameter definitions) the factthat the first two slots of a cell (represented by the first twoparameter overrides) can only accommodate a power supply, and theremaining slots available for modules.

1.3.7.4 Source/Sink Connectivity

FIG. 26 depicts an implementation of how source/sink relationships canbe implemented in IDA. The following table depicts the connectivity dataneeded to support these connections at the object level:

Source Object Type Connection Type Sink Object Type AIN Block BlockConnection PID Block PID Block Block Connection REALM Block

The following table depicts the connectivity data need to support theseconnections at the parameter level:

Source Sink Parm Type Min/Max Connection Parm Type Min/Max PNT1/unlimited Block Connection MEAS 0/1 MEAS 1/unlimited Block ConnectionMEAS 0/1

This example depicts how data can be structured to handle a source/sinkconnection. More importantly, it shows how the same parameter (i.e., inthis case, the MEAS parameter of the PID block) can function as bothsource and sink simultaneously.

1.4 Placeholders

The primary purpose of Placeholders is to preserve the location andappearance of an object on a Persistent Document, enabling an object toretain its appearance between viewings. Placeholders present an objectmodel, depicting all the objects, their connections, and the endpointsof those connections in a single diagram. Consequently, the object modeldealing with placeholders will broken into two sections:

Appearance Object Model. Objects of the same type appear in a certainway, depending upon which view it's being displayed in. This appearanceis defined in an instance of the Appearance Definition class, whichdescribe through the use of macros how a certain type of object appears.The Framework supports both a Implementation-standard, as well as auser-defined, appearance definition of an object type. Finally, aPlaceholder Type class links an object type with a view type, with theappearance definition which is dictates how the object type appears onthat view type.

-   -   1. Placeholder Object Model. This object model details how the        placeholder class may actually be abstracted into three        different classes: one each to support endpoints, connections,        and objects.

1.4.1 Appearance Object Model

The object model depicted in FIG. 27 centers around how objects of acertain type appear when displayed on various types of views.

1.4.1.1 Placeholder Type

The Placeholder Type class is analogous to a join table betweeninstances of the Object Type class and The View Type class, representingvalid combinations of object types vs. view types. If a specific objecttype is not found in any instance of the Placeholder Type class, then noobjects of that type will be able to be displayed on any view of thatview type.

By referencing instances of the Appearance Definition class, thePlaceholder Type class is also responsible for determining how an objectof a specific Object Type appears on each view type it is able to bedisplayed on.

Summarizing Relationships:

-   -   The Placeholder Type class is a base class, instance of which        define “legal”, or valid, combinations of Object Types and View        Type. Each instance of a Placeholder Type represents the        appearance of a single valid object type on a specific view        type.    -   The Placeholder Type class is analogous to a join table to        separate the many-to-many relationship between object types and        view types. In other words, the same Object Type can appear in        many different View Types, and the same View Type can be used to        display many different objects of the same Object Type.    -   An instance of the Placeholder Type class ties the object        type/view type pair to an object appearance via its association        with an instance of the Appearance Definition class, which is        used to specify how an object type appears in that view type.

1.4.1.2 View Type

The View Type class represents the document (and supporting view,speaking in MFC terms) on which Parameterized Objects are displayed. Notall view types display all object types, and valid combinations aredictated by instances of the Placeholder Type class.

Summarizing Relationships:

-   -   Each instance of the View Type class has a one-to-many        relationship to instances of the Placeholder Type class. Each        view type is capable of displaying one or more object types,        with each valid View Type/Object Type pair represented by an        instance of the Placeholder Type class. The appearance of that        object on that view type is specified by the associated        Appearance Definition object.

1.4.1.3 Appearance Definition

The Appearance Definition class is just that—it defines the appearanceof an object type on one or more types of views. The AppearanceDefinition object may be thought of as a small-scaled Sheet Template(refer to the section on “Sheet Templates”). The appearance of anobject, if specified as a template, is macro-driven, allowing the userto edit and modify the way objects appear in certain View Types. Forexample, a possible Appearance Definition for a Parameterized Objectmight appear as that shown in FIG. 28, where the macros [$NAME], [$ICON]and [$TYPE] have specific values which have been obtained from theassociated Parameterized Object at runtime.

All Parameterized Objects have a default Implementation-standardAppearance Definition for every View Type which they are allowed toappear on in IDA. The user can modify these Appearance Definitions, andsave them as the new “default” Appearance Definition for that objecttype/view type pair.

1.4.1.4 Implementation-Standard Appearance Definition

Instances of Implementation-standard Appearance Definition objectsrepresent the default appearance of an object when placed on an instanceof a specific View Type. A Implementation-standard Appearance Definitionobject may be overridden by a User-Defined Appearance Definition objectat runtime to produce customized displays and printouts to satisfyunique customer documentation requirements.

Every Object Type/View Type pair found in instances of the PlaceholderTypes class has an inherent Implementation-standard AppearanceDefinition associated with it.

1.4.1.5 User-Defined Appearance Definition

A User-Defined Appearance Definition object is a “copy” of aImplementation-standard Appearance Definition object which has beencustomized by the user to satisfy unique documentation requirements. Theuser can modify the default appearance definition by using an editingtool similar to the Sheet Template Editor to modify the appearance of anobject type when displayed on a specific view type. The defaultappearance definition for an object will be overridden simply by virtueof the fact that a User-Defined Appearance Definition object exists forthe object type/view type pair.

1.4.2 Placeholder Object Model

A placeholder is created at runtime whenever a new instance of aParameterized Object, Connection, or Endpoint is placed on a view. Theplaceholder retains geometric information (e.g. size and location) and areference to the object's Appearance Definition which determines how theobject appears in the view. The placeholder is the mechanism by whichall this information is kept persistent within the document (FIG. 29).

1.4.2.1 Abstract Placeholder

The Abstract Placeholder class is an abstract class which is used toprovide the mechanism by which the representation of objects on aPersistent Document object are made persistent. Every object which needsto be represented on an instance of a Persistent Document (e.g. anEndpoint, an Connection, or a Parameterized Object) uses a subclass ofthe Abstract Placeholder class and extend it to meet its specificrequirements in terms of being able to reconstruct itself visually.Placeholders are used to represent an object regardless of the nature ofthe Persistent Document (e.g. graphical vs. tabular).

At a minimum, the data which an Abstract Placeholder contains includesthe origin (x,y) of the object, and its extents. The ordered listmaintained by the Persistent Document determines the order in whichobjects are drawn.

Summarizing Relationships:

-   -   A Placeholder object (whether it be for Endpoint, Connection or        Parameterized Object) is contained within a Persistent Document.        The representation of an object, for any specific document, is        dependent upon the Placeholder and the associated Appearance        Definition object, for that object.    -   One or more Placeholder objects may be associated with the same        Persistent Document. The Persistent Document will maintain an        ordered list of the Placeholders it contains.    -   All instances of the placeholder class maintain a reference to        the object they represent, in the event that they receive a        notification that the object has been modified, or deleted. In        this manner, they can take the appropriate action in order to        refresh the display.

1.4.2.2 Parameterized Object Placeholder

A Parameterized Object Placeholder object extends the AbstractPlaceholder class with data and/or methods to allow the associatedParameterized Object to be displayed on the Persistent Document object.In addition to the standard configurable objects (e.g. blocks, loops,etc.) all non-configurable Graphical Objects (discussed under thesection entitled “Sheet Template Editor”) are also derived fromParameterized Object so that they may benefit from theObject->Placeholder->Document relationship.

Examples of Parameterized Objects which subclass the AbstractPlaceholder with object-specific data include:

-   -   “Normal” Objects Data can include size, shape, color, line        weight, line style. Some objects may include a bitmap (or        reference to one) to enhance the appearance of the object. Such        objects can include blocks, representations of hardware        components, and most Graphical Objects (e.g. rectangles,        circles, etc.).    -   Object CollectionsData can include size, shape, color, line        weight and line style. Implementation can set these properties        for all objects within the collection. Such objects would        include nests, loops and compounds.    -   Textual Objects Data can include font (size and style), color,        and background. Such objects include annotators on the Sheet        Template, as well as those placed on the Persistent Document by        the user.

Summarizing Relationships:

-   -   An instance of a Parameterized Object Placeholder object is used        to represent one, and only one, Parameterized Object on an        instance of the Persistent Document class.    -   Parameterized Object Placeholder objects maintain a reference to        their associated Parameterized Object in order to dynamically        refresh any related data which may have changed outside the        context of the current Persistent Document.    -   Parameterized Object Placeholder objects (from the previous        discussion on appearance objects) maintain a reference to their        associated Placeholder Type object.

1.4.2.3 Connection Placeholder

A Connection Placeholder object extends the Abstract Placeholder classwith data and/or methods to allow the Connection to be displayed on thePersistent Document object. Data with which the Abstract Placeholder issubclassed for a Connection Placeholder include line weight, line style,and color. Examples of Connection Placeholders are those used torepresent the block connection between blocks and their respectiveparameters, or a fieldbus connecting a CP to an FBM.

Summarizing Relationships:

-   -   A Connection Placeholder object is used to represent one, and        only one, Connection object on an instance of the Persistent        Document class.    -   Connection Placeholder objects maintain a reference to their        Connection object in order to dynamically refresh any related        data which may have changed outside the context of the current        Persistent Document.    -   Since a Connection object is a Parameterized Object, it follows        that instances of Connection Placeholders (from the previous        discussion on appearance objects) maintain a reference to their        associated Placeholder Type object.

1.4.2.4 Point Placeholder

A Point Placeholder object extends the Abstract Placeholder class withdata and/or methods to allow the associated EndPoint object to bedisplayed on the Persistent Document object. Data with which theAbstract Placeholder is subclassed for a Point Placeholder object mightinclude shape, line weight, line style, and color. Examples of instancesof Point Placeholders are those that could be used to represent aparameter on a block, or a point on an FBM.

Summarizing Relationships:

-   -   A Point Placeholder object is used to represent one, and only        one, Endpoint object on an instance of the Persistent Document.    -   Point Placeholders objects maintain a reference to their        associated Endpoint object in order to dynamically refresh any        related data which may have changed outside the context of the        current Persistent Document.    -   Unlike instances of the Parameterized Object and Connection        Placeholder class, Point Placeholder objects do not contain a        reference to a Placeholder Type object, but rather are        responsible for determining their appearance using inherited        methods and/or data.

1.4.2.5 Persistent Document

A Persistent Document object is used to contain the data associated witha specific document within IDA. It's important to note that a PersistentDocument is directly related to an MFC Document, although differences doexist. A Persistent Document may only be associated to one and only oneSheet Template (see section entitled “Sheet Template Editor”). When thedocument is displayed, the Sheet Template is drawn first, as a type ofbackground, then the Placeholder objects associated with the document issuperimposed upon the drawing surface. The Sheet Template, which is usedduring printing and/or print preview, is user-selectable from the PageSetup dialog. In the absence of a user-specified Sheet Template, adefault implementation-standard template is used.

1.4.2.6 Combined Placeholder/Appearance Object Model

FIG. 29B depicts a combined placeholder and appearance object model usedin one practice of the invention. The classes illustrated in the drawingare defined as discussed above, with the following caveats.

Each configurable Parameterized Object utilizes parameters (here,identified as Appearance Parameters) that reference (or contain)instances of an Appearance Definition class specifying how thatParameterized Object appears in respective views—and, particularly, inthe respective editors (e.g., the Block Definition Editor, ControlAlgorithm Diagram Editor, and so forth). This use of AppearanceParameters substitutes for (or supplements) the above-described use ofthe Placeholder Type class.

Appearance Parameters are treated in the manner of other ParameterizedObject parameters and hence, for example, are inherited from parentobjects, may be edited and/or may be overridden. Thus, a “default”Appearance Definition associated with a configurable object as aconsequence of inheritance may be changed, e.g., through use of theBlock Definition Editor. Moreover, Appearance Definitions required fordepiction of a configurable object in additional editors may be added toa “child” Parameterized Object, e.g., in the manner that otherparameters are added to an Parameterized Object definition.

Embodiments utilizing the model of FIG. 29B forego ConnectionPlaceholders in favor of Connector Graphics that are integral to thegraphical display of each Persistent Document. Each Connector Graphic ina Persistent Document references the corresponding parameterizedConnection Objects. By checking those references, an editor that displaythe Persistent Document can verify the existence of each ConnectionObject before displaying the Connector Graphic.

1.5 The Generic Editor Framework Classes

The IDA application in general, and the IDA editors in particular arebased on the Microsoft Foundation Classes' (MFC) Document/View model.

The MFC Document/View model relies on the interaction of several classes(as shown in FIG. 30). An Application object (using a containedCDocManager object) maintains a list of one or more Document Templates.Each of the Document Template objects represents a tuple consisting of aFrame class, a Document Class, and a View class. Together, this tripletof classes, when instantiated as objects, defines the appearance of theprogram, the data being edited, and the program's user interface,respectively.

The document objects define and maintain the data being edited. Theframe objects define the menus and toolbars available when the documentsare edited. The view objects draw the objects being edited on the screen(or during printing) and manage the details of the user interfaceinteractions.

Each of the editors is packaged as a Win32 DLL (dynamic link library).The DLL includes the supporting code for the sub-classes of CFrameWnd,CDocument, and CView that make up the editor's code. When the DLL isloaded, a document template instance containing references to theseclasses is created and passed to the application. Once the documenttemplate is managed by the application, the editor is available for use.This isolation from the application object's code (which is compiledinto the process's EXE) and the editors' code (compiled into variousDLLs) is illustrated by the DLL Boundary shown in FIG. 30. Theapplication, may, at a later time unload the document template once theeditor the code implements is no longer in use. At that time, the DLLcan then be released.

When a user action results in a new instance of an editor, theapplication retrieves the appropriate Document Template instance fromits manager. It then asks the template to create new instances of theappropriate frame, document and view objects, placing the windows in theedit pane of a main editor window.

When the user selects a new document object (of a different type) in thetree control, the framework attaches an instance of the appropriateFrame class to the frame window (detaching the previous Frame class).This causes the menus and toolbars for the frame to change to thoseappropriate for the new editor. The editor's View class is theninstantiated as the new View Pane of the frame.

The IDA Framework provides several base classes to facilitate thecreation of IDA applications. Most are derived from the standard MFCDocument/View architecture classes defining the application, the frame,the document and the view.

1.5.1 COM Architecture in IDA

The Component Object Model (COM) (a collective term used to describeaspects of a Windows NT Object Linking and Embedding (OLE) object) isutilized by IDA in three ways—internal automation, external automation,and application/editor interaction.

The framework used for automating parameterized objects and IDA isindependent from the parameterized object and Framework Servicesframework classes, and can be implemented separately. However, there aresome coding practices that make integration of parameterized objectswith the automation framework easier. The framework used for interactionin IDA and its editors needs to be tightly coupled with the MFC classes.

It is apparent that all classes implementing COM functionality arepreferably kept separate from the persistent object model for the samereasons MFC classes must be. COM needs to keep track of informationrelated to the lifetimes of objects on a per application basis, andtherefore is not compatible with IDA's multi-user database model. Theexception to this rule is a pseudo-implementation of the OLE automationserver, IDispatch, by parameterized objects that will be wrapped by anobject providing the actual functionality expected for automation.

1.5.1.1 Internal Automation

This type of automation is typically referred to as “Scripting”. Byexposing parameterized objects through automation and defining eventinterfaces, a scripting engine (such as VBScript) can be hooked into torun event-based scripts. This is a powerful tool for easily building andmaintaining IDA functionality, as well as giving users an extremely richand flexible way to customize and extend IDA.

As mentioned above, parameterized objects provide apseudo-implementation of IDispatch. An automation wrapper class is usedto handle all calls to the methods of IDispatch on behalf of theparameterized object using an ObjectStore reference. The wrapper objectis created through an automation manager that is also used for firingevents for parameterized objects.

An event is handled using a script (VBScript) that is persisted in aparameterized object and passed with the object itself to the automationmanager. An editor is provided to manage the scripts associated with anobject. A script has the context of the object it belongs to, along withthe global IDA application object discussed in the next section. Fromthe global IDA application object, one has access to all thefunctionality exposed through automation for IDA and the editors. Thisincludes access to parameterized objects in the system and planthierarchies.

1.5.1.2 External Automation

All automation interfaces used for external automation are dualinterfaces to provide the best level of efficiency and ease of use. Adual interface is a custom interface that derives from IDispatch.

IDA has an Application object that serves as the automation entry point.The object is registered with Windows as a local server allowing VisualBasic or C++ developers to create one and use it in their ownapplication. From this entry point, developers have access to all thefunctionality exposed through automation for IDA and the editors. Thisincludes access to parameterized objects in the system and planthierarchies using an automation wrapper object. Examples of objects thatwould be properties of the Application object are the palette window,the project manager window, output window and the editor manager. TheApplication object may also have methods or child objects with methodsthat provide helper services and routines living in DLLs.

IDA GUI classes are exposed through automation by aggregating a dualinterface into an MFC class and adding it as a property of theApplication object. Developers can choose to implement theirfunctionality in either the MFC class or the aggregated interface, andcall one from the other. IDA also abstracts the editor manager with anautomation object. Editors provide one or more automation interfaces toexpose their functionality through automation. Although all the editorsmay have one or more common automation interfaces, each can have as manyunique ones as necessary.

1.5.1.3 Application/Editor Interaction

In the illustrated embodiment, these interfaces do not supportautomation, and are implemented in non-MFC/non-parameterized objectclasses.

There are a number of COM interfaces that are implemented by the IDAapplication, and managers that are used to synchronize GUI-related andother operations. These are non-automation custom interfaces withassociated proxy/stub classes provided by IDA used for marshalling data.The difference between these interfaces and the ones used for externalautomation is that these are used solely for the coordination of theeditors with IDA and are not editor-specific. The automation interfacesare typically unique to the editor they belong to.

As with the automation interfaces, special consideration is given toparameterized objects. In the illustrated embodiment, pointers arepassed to parameterized objects and OID's using the “long” data type andcasting appropriately. This is permissible because the embodimentoperates in a single process, that is linked to the DLLs exporting itsclasses, and is integrated with ObjectStore. In alternate embodiments, aCOM interface/class can be implemented for each parameterized objectdefined. These classes can live in non-extension DLLs and can wrap theircorresponding parameterized objects using OID handles. Additionalapplication/editor interfaces can be implemented using the objectinterfaces instead of the “long” data type.

1.5.2 The IDA Application Class

There is a single IDA application class—there is a single IDAapplication. It supplies standard services to the application, and tothe classes that make up the application. These services include:

-   -   Transaction Services    -   Undo Services    -   Window Management    -   Version Control    -   Security and Authentication Services

It also provides the dynamically loadable (and unloadable) documenttemplate facility. As shown in FIG. 31, the application class is derivedfrom MFC's CWinApp class. An intermediate abstract class (whichimplements most of the application's services) is shown.

1.5.3 The IDA Document Manager Class

This class manages the document templates for each editor. This class isused to manage the loading and unloading of editor DLLs. When an editoris unloaded, its document template is preferably be removed from thelist of available templates. The document templates contain pointers toobjects which reside in the editor DLL, and might be located differentlyif the editor is reloaded.

When an editor is installed on a target system, it registers itselfbefore use. Registration stores and relates three pieces of informationabout the editor:

-   -   The path to the DLL    -   The editor's unique identifier (i.e., the GUID for that editor)    -   Identifies itself as an IDA editor

The third item, IDA editor information, is stored in the registry viathe use of the COM Components Categories Manager (COM-CCM). The COM-CCMis a single instance COM component which allows applications like IDA toregister a category (i.e. IDA editors) and servers that support objectsin that category (e.g., Block Definition editor, etc.)

On initialization, CDocManager retrieves a list of available editors viathe COM-CCM. Once that list is retrieved, an editor can be started byinstantiating it via COM using the GUID stored in the appropriatecomponent category.

Once the editor is loaded, it registers the document template with themain application, and can then be used like any other document template.

1.5.4 The IDA Document Classes

FIG. 32 shows a class diagram for IDA documents. In IDA, the documentclasses differ from the other Document/View components, in that theyrepresent persistent data. The figure consists of many categories ofobject classes. These include:

-   -   The non-persistent (CDocument-derived) documents that represent        the persistent document in an editor    -   The persistent documents that collect objects into editing        contexts    -   The Parameterized Objects that are the configurable items in the        database    -   The persistent Placeholder objects that tie the configurable        items to their document(s)    -   The non-persistent proxy objects that act as on-screen tokens        for configurable item placeholders during editing

The base IDA document classes include provisions for embedding OLEobjects within an IDA document, and for providing linkings to IDAeditors via OLE from other applications.

In FIG. 32, the classes which begin with “Editor Specific” are createdand maintained by the application developer (along with the individualIDA object class). The remaining classes are provided by the Framework,or MFC.

1.5.5 The IDA Hierarchy Tree Class

The IDA Hierarchy Tree provides two hierarchical views of the componentsof an IDA configuration. FIG. 33 shows an approximation of the classinter-relationships for the IDA Hierarchy Tree.

The IDA Hierarchy class provides most of the services available in thetwo hierarchy trees. These include general database connectivity,dynamic update from the database, and drag and drop, cut/paste services.The Plant and System Hierarchy sub-classes are simple specializations ofthis class. The Specialized Tabbed View class acts to hold the two viewsin a single tabbed container (i.e., the IDA Hierarchy Tree).

1.5.6 The IDA View Classes

The IDA Framework provides base view classes (derived from MFC's viewclasses) providing application developers with much of the userinterface behavior they need in their applications. FIG. 34 shows amodel of the relationships of these classes.

The Specialized IDA Document Base Class shown in FIG. 34 corresponds tothe same class as shown in the IDA Document classes. The “VirtualRelationship” between the CView and CDocument classes is common to allMFC document/view applications, and is actually implemented in mostderived application-specific view and document classes.

The Base IDA View Class provides the basic user interface services.These include page and print services (most IDA applications arepage-based—their final output is a page, or pages, in a book of systemdocumentation), notification services, invalidation and the relationshipto an IDA Hierarchy Tree control.

The Graphical IDA View Base Class provides the facilities needed for asimple graphical editor (object placement on a page, or “canvas”). Twosub-classes of this view, the Block and Connection View Class, and theEnclosure View Class, add connection and containment user interfaceattributes to the services already provided by the graphics class.Similarly, the Tabular IDA View Base Class adds the data and methodsnecessary to provide a grid, or spreadsheet-like, user interface. Twosub-classes of the tabular base class are the List View class, used forlisting properties and attributes of items selected in the IDA HierarchyTree, and the Grid View class, used for other spreadsheet editors suchas the Parameterized Object Definition editor.

Application developers are expected to sub-class their view class fromone of the provided base classes.

1.5.7 The IDA Frame Classes

FIG. 35 shows the structure and relationships of the base IDA FrameClass. The MFC frame classes provide the menus and toolbars, and somegeneralized behavior of MFC applications. Many classes presented in theprevious section in FIG. 34 and FIG. 35 are shown here to depict therelationships between the various classes involved.

The IDA Editor Frame controls lines of communication between the IDADocument Base Class, and the IDA Main Frame.

The IDA system has specialized menu and toolbar management, allowing thedynamically loaded menus and toolbars to negotiate with the standard IDAfacilities. Menus and toolbars associated with the main application aremerged with the menus and toolbars associated with each editor as itbecomes active.

1.6 Sheet Template Editor

Sheet Template objects are used to allow the user to define a template,or sheet layout, to be used during the printing and/or print previewprocess. A Sheet Template typically includes combinations of graphicalsymbols which have been defined (e.g. rectangles, circles, bitmaps, etc.. . . ) to satisfy a customer's unique requirements for documentation.

Sheet templates are used to augment the documentation process withinformation which may be used to point out, or highlight, portions ofthe configuration. Sheet templates support the inclusion of a variety ofgraphical objects to help in this task, such as geometric shapes,bitmaps, and annotators (text blocks).

Sheet templates are created and modified by the Sheet Template Editor.This graphical-based utility allows the user to modify existinggraphical objects, add new ones, and change the size of the drawablesurface area on which output is displayed.

1.6.1 Object Model

The object model used in the illustrated embodiment to support SheetTemplate objects appears in FIG. 36.

1.6.1.1 Sheet Template

Sheet Templates objects are actually specialized Persistent Documentobjects created and maintained by the Sheet Template Editor. Each SheetTemplate object contains a reference to one or more representations ofGraphical Objects, via instances of the Abstract Placeholder class.Placeholders are used to provide the mechanism for persistent storage ofthe placement of various objects in the Sheet Template.

When a Sheet Template object is being accessed via the Sheet TemplateEditor, instances of Graphical Objects may be moved, modified, anddeleted as desired. However, when a Sheet Template is used for displayduring printing or print preview purposes, it serves as an uneditablebackground meant to further enhance the appearance of the report it isassociated with. When viewed in this manner, Graphical Objects on theSheet Template may not be manipulated, moved, or changed in any way.

The Sheet Template object which is actually used during print and/orprint preview is defined by the Page Setup dialog box. Should the userelect not to use Page Setup capabilities, a default Sheet Templateobject is available while the configurator is providing normal printingservices.

Summarizing Relationships:

-   -   A Sheet Template object is a specialized Persistent Document.    -   One or more placeholder objects representing Graphical Objects        may be contained within the Sheet Template.    -   There is an implied relationship wherein a Sheet Template object        can reference (albeit indirectly) one or more instances of        Graphical Objects, but that an instance of a Graphical Object        can only appear on one, and only one, Sheet Template object.    -   An instance of a persistent document may only be associated with        a single Sheet Template object. However, the same Sheet Template        object may be associated with several persistent documents at        the same time.

1.6.1.2 Graphical Objects

While creating or modifying a Sheet Template, numerous Graphical Objectscan be drawn which are then used to form the background (or sheetlayout) to be used during printing and/or print preview (FIG. 37). TheseGraphical Objects are independent of the objects normally considered tobe “configurable”, such as loops or compounds. In that context, types ofGraphical Objects include:

-   -   Rectangles    -   Circles (Ellipses)    -   Polylines    -   Bitmaps    -   Icons    -   Annotators (used to display text)

Graphical Objects require the management of graphical characteristicssuch as line weight, line style, line color, fill color, etc. Theseproperties may vary depending upon the object type being modified, andare displayed on that object's property pages appropriately when edited.Annotators, or text strings, support the use of macro substitution,allowing the user to enter specific, predefined macros embedded withintext strings. When the text string is displayed on the Sheet Template,the macro is replaced with the appropriate value. Examples of things forwhich macros are defined include: report name; customer name; user name;and date and time in various formats.

Summarizing Relationships:

-   -   An instance of a Graphical Object is a Parameterized Object,        created and manipulated by the Sheet Template Editor.    -   An instance of a Graphical Object may be associated with one        Parameterized Object Placeholders. These Placeholders provide        the mechanism by which a Graphical Object's location and        appearance on a Sheet Template can be made persistent.    -   There is an implied relationship directly with the associated        Sheet Template object itself—and that is, that a Graphical        Object can be associated with one, and only one, Sheet Template        object.

1.6.2 Sheet Template Editor

Although IDA can include predefined, standard Sheet Template objects,the Sheet Template Editor (FIG. 38) may be used to create new SheetTemplate objects, or customize existing ones. Conceptually, the SheetTemplate Editor is similar to many drawing packages which exist on otherplatforms and systems today. The editor provides the primary mechanismfor allowing users to modify graphical characteristics of the GraphicalObjects displayed on a Sheet Template. A full range of graphicallyrelated commands allow the user to manipulate objects which have beenplaced on the Sheet Template, such as various alignment commands, sendto front/back, etc.

One important feature of the Sheet Template Editor is to allow thedefinition of the size and orientation of the area representing thephysical paper surface (e.g., 8½×11 portrait). Also defineable withinthe editor is the drawing area, which is essentially used to define thetop, bottom, left and right margins of the drawing surface available tothe user for placement of configurable objects. While in the editor,instances of Graphical Objects may be placed outside the normal margindepicted by the drawing area (e.g., a Title Block at the bottom of asheet). Graphical Objects preferably still remain within the physicalboundaries of the selected sheet. Any Graphical Object may be created,modified, moved, or deleted from the template, regardless of the sizeand position of the drawing area.

1.7 The IDA Report Manager

The IDA Report Manager allows users to create, edit, and print reports.A report is an association between a collection of IDA configurableobjects (possibly filtered) and templates describing how to print them.Reports are composed of report templates that organize the data to beprinted—describing what should be printed, how it should be printed, andin what order. This enables the user to produce a printed document thatcombines information from various sources organized in one of manydifferent ways (FIG. 46). For the remainder of this section, IDAconfigurable objects will be referred to as simply “objects”.

An object may be associated with one or more named views, each used torender a specific representation of it inside an IDA editor. Editors arecomponents of the IDA application. Each editor provides a graphical userinterface (GUI) to allow the user to edit one or more objects, eachobject being associated with one or more object types. A central viewregistry keeps a list of views for each object type, and for each view,the name of the editor that implements the GUI for it. In addition, foreach object type, one of the views is marked as the default.

Each of the IDA editors is a Microsoft Windows server implemented in aDLL using the MFC document/view architecture. In an IDA editor, an MFCdocument is associated with an object and an MFC view is associated witheither an IDA named view, or the placeholder object used to render thatnamed view of the object.

An object can be printed either as part of a report or individuallythrough an IDA editor. All printing is performed using the MFC printingmechanism up until either the report or the object actually printsitself. At this point, the MFC view calls into either the report or theplaceholder/appearance object associated with the object being printed.A report is responsible for making the calls into theplaceholders/appearance objects for the objects it is currentlyprinting.

1.7.1 Object Model

FIG. 39 depicts the object model used in the illustrated embodiment tosupport the Report Manager, which maintains the following three lists:reports; report templates; and property filter rules.

In the illustrated embodiment, only one Report Manager can exist in anIDA system, and it is a top-level member of the System Hierarchy. To theuser, its representation in the System Hierarchy is an untypedcollection, only capable of being opened and closed. It contains threelists, each being a Parameterized Object. Nothing can be added to theReport Manager's “folder” on the System Hierarchy, and none of the threelists can be deleted. The IDA Report Manager relies on a parallelregistry of printable views with the following conditions: one or moreprint views is registered for each Object Type; and of the Object Type'sprint views is registered as the default.

1.7.1.1 Printable Object Collection (POC)

A Printable Object Collection (POC) organizes a list of references toobjects (typically, a subset of the Plant or System Hierarchies)intended to be printed together to form a “book” of printed output. Thelist of objects is transient, and are preferably first generated usingthe Scope and Property Filter Rule objects before being used by aReport.

The POC uses its Scope and Property Filter Rules to populate itself withobjects fitting certain criteria. They also apply an ordering toobjects. All functionality for populating the object list lies withinthe POC class.

Object filtering happens at two different levels. First, objects areadded to a temporary list that passes through the Scope Filter Rule.Then objects in the temporary list pass through the Property FilterRules, and are added to the final list that is used by the Report.

As shown in FIG. 40 the following steps are taken to filter objectsbased on scope:

-   -   1. A temporary Object Type list is generated, containing each        Object Type associated with the Report to which the POC belongs.        The Object Types consist of those that all Report Templates in        the Report have in common that do not derive from any of the        others in the list.    -   2. If the Scope Filter Rule's list is empty, the tree root        object is added to it temporarily.    -   3. For each Object Type in the temporary list, the following        steps are taken:        -   a. Each object in the Scope Filter Rule's list matching this            Object Type is added to the temporary list.        -   b. Objects in the Scope Filter Rule's list that do not match            this Object Type have their “children” searched recursively            for those matching the type. Child objects matching this            Object Type are then added to the temporary list.

The following steps are taken to filter objects based on propertyvalues:

-   -   1. Objects are added to the final object list if they evaluate        correctly for each property filter expression in the Property        Filter Rule.    -   2. If there is no Property Filter Rule, all objects in the        temporary list are added to the final list.

The only object that is treated differently by the POC than otherobjects is the type that is a link to an Active Document object. Theseobjects are added to the final object list during the POC's first passthrough the Scope Filter Rule and are not affected by the PropertyFilter Rule.

1.7.1.2 Property Filter Rule

A Property Filter Rule acts to populate a Printable Object Collection(POC) by specifying one or more property filter expressions thatpreferably evaluate correctly for each object in the POC's temporarylist before it can be added to the POC's final list. Objects in thePOC's temporary list are those that have passed through the POC's ScopeFilter Rule. For properties of the rule that do not exist in an objectbeing filtered, the filter expression evaluates correctly. This can onlyhappen with expressions with type=‘ALL’. A single Property Filter Rulemay be associated with more than one POC.

The Property Filter Rule object's parameterized properties map aProperty Name to a structure holding a Filter Value, Object Type, and anExpression defining the property value's relationship to the filtervalue.

-   Example: The Property Filter Rule with Property Name=“Block Name”,    Expression=“=”, Filter Value=“FID*”, and Object Type=“I/A Blocks”    will limit “I/A Block” objects in the POC to those whose Block Names    match the pattern “FID*”.

1.7.1.3 Scope Filter Rule

A Scope Filter Rule acts to populate a Printable Object Collection (POC)by specifying an ordered list of objects that are searched (or whosechildren are searched) for those matching a specific type. Objectsmatching this type are added to the POC's temporary list and are furtherfiltered by the POC's Property Filter Rule before being added to thePOC's final list. The objects in these lists remain in the order theywere added and are subsequently printed in this order by the Reportassociated with the POC. A Scope Filter Rule can also contain a type ofobject that is a link to an Active Document object. These objects aretreated a little differently by the POC.

1.7.1.4 Report

A Report is an association between a Printable Object Collection (POC)and a list of Report Templates. It is a Parameterized Object maintainedin a list by the Report Manager. Report names are preferably uniquewithin the scope of the Report Manager.

In a Report, the POC contains a list of objects that are to be printed,and the Report Templates describe how they are to be printed. If noobjects in the POC match an Object Type associated with a given ReportTemplate, then no object will be printed. The Report preferablyinitializes the POC before getting the objects to print.

A Report maintains default Print Specifications (i.e., paper size,orientation, etc.) that are configurable by the user. If the job iseither quick printed using the print toolbar button or printed as partof a batch print job, the stored Print Specifications are used. Thesedefault specifications may be overridden by the object type-specificPrint Specifications associated with a Report Template within theReport.

1.7.1.5 Print Specification

A Print Specification physically describes how printable views ofobjects should be printed. It includes:

-   -   The physical description of the paper size and type (not to be        confused with the logical paper size and type which is described        by the sheet template attached to the printable view)    -   The orientation of the printing to the paper (landscape,        portrait, or natural)    -   Whether the logical view should be tiled onto the physical        paper, or sized to fit the paper

Reports have a default Print Specification which may be overridden bythe Print Specification associated with a Report Template. If an objectis of a type having a Print Specification, these override all othersduring printing. All instances of Print Specifications except thosebelonging to an Object Type can be edited by the user.

Print Specifications are used with the following precedence (from highto low in order of importance):

1. Object Type Print Specification 2. Report Template PrintSpecification 3. Report Print Specification

Individual specifications within a Print Specification can beoverridden.

-   Example: An Object Type may specify that it needs to be printed out    with a Landscape paper orientation, and a certain width and height,    but it may accept the default Sheet Template associated with the    Report Template.

Every Print Specification has a Sheet Template that is used to provide abackground for report pages.

Instead of the Report having a hard coded Print Specification that needsto be overridden by each Report Template, the Report Manager can have adefault Print Specification associated with it that is applied to newlycreated Report objects. This allows users to go to a single location toconfigure the default Print Specification for each new Report that willbe created.

1.7.1.6 Report Template

All instances of Report Templates in the system are maintained in a listby the Report Manager and preferably have unique names identifying them.There are three types of Report Templates all deriving from the ReportTemplate base class: Graphical Report Templates, Tabular ReportTemplates, and Composite Report Templates.

Report Templates have one or more Object Types associated with them thatdetermines what objects the Report Template can be applied to, forminglegal relationships.

A Report Template may maintain a default Print Specification (i.e.,paper size, orientation, etc . . . ) that is configurable by the user.This Print Specification overrides those associated with the Report whenprinting objects. The objects themselves are associated with an ObjectType which may have a Print Specification that in turn, overrides theone specified by the Report Template. The Object Type's PrintSpecification is not editable.

A number of Standard Report Templates are included. These includeimplementation-standard Graphical and Tabular Report Templates that areprovided as read-only templates. With these templates, users are able toreport data for any objects in a number of practical formats. Users alsouse these Standard Report Templates to build custom Composite ReportTemplates.

1.7.1.7 Graphical Report Template

A Graphical Report Template is a Report Template that represents a fixedassociation between its object types, and a set of object type-specificrules for printing (Object Type Rules). This type of Report Templateprints objects as “What-You-See-Is-What-You-Get” (WYSIWYG) reports—thesame way they are seen from within the graphical editor.

A Graphical Report Template also maintains print sequence information.This information includes the order print views should be printed in,and whether objects get printed consecutively with each of their views,or grouped by view. In some embodiments, users will be able to create aneditable copy of a Graphical Report Template.

1.7.1.8 Object Type Rules

Object Type Rules specify how objects with a specific Object Type shouldbe printed. It names the Object Type, and lists the named print viewsthat should be printed.

Object Type Rules provide the following information: the default printview for the Object Type; specific named views to be printed for theObject Type; and all print views registered for the Object Type.

1.7.1.9 Tabular Report Template

A Tabular Report Template is a Report Template that represents a dynamicrelationship between presentation information, and a query responsiblefor populating the presentation to be printed. Unlike a Graphical ReportTemplate that is only concerned with static WYSIWYG representations ofindividual objects, Tabular Report Templates combine the informationabout many objects into one Crystal Reports report that can be sortedand grouped as desired.

1.7.1.10 Presentation Object

The Presentation object contains information about how to retrieve thedata to be printed, and how to print it out as a Crystal Reports report.It also specifies how the data should be grouped.

The Crystal Reports report expects to find data in a fixed “n×n” array.It uses this data to populate itself in its persisted format.

Example:

Name Sequence code Block Count Loop1 Primary Loop 1 3 Loop2 SecondaryLoop 2 5 Loop3 Tertiary Loop 3 2

A Presentation object for a Tabular Report Template that prints loopobject information may retrieve data for the “Block Count”, “Name”, and“Sequence Code” properties of each loop object. It would then put thedata into a 3×Loops array with the properties in the order “Name”,“Sequence Code” and “Block Count”. The report can be persistentlyformatted to sort the object by “Name”, or saved with no groupinginformation so that it can be grouped on the fly by the Presentationobject.

If the user can customize how the data in the report is grouped, theQuery object for the Tabular Report Template indicates the propertiesthat the user can group by. The user could choose to sort loops by“Block Count” rather than by “Name”. The Presentation object has a listof object type and/or property names that it uses to retrieve data fromthe objects contained in the report. The data is then organized into an“n×n” variant array passed to the Crystal Reports report.

1.7.1.11 Query Object

The Query object contains information to be used for selecting the datato be printed, and also specifies what aspects of the query are userconfigurable. Most of the user configurable aspects of the query pertainto Filter Rules, but some are formatting rules that apply to thePresentation Object.

A Query object contains the following information:

-   -   Required expressions to be added to a Property Filter Rule at        runtime used to filter objects included in the report.    -   Limitations on what expressions users can specify in the        Property Filter Rule used to avoid conflicts with required        expressions.    -   The names of properties that the data in the report can be        grouped by used by the Presentation object.

-   Example: A Query object for a Tabular Report Template the prints    loop object information can impose a Property Filter Rule expression    that only loops with more than 10 blocks are to be in the report.    The expression would be added to the Property Filter Rule of the    Report's Printable Object Collection (POC) at run time.

The Query object may impose limitations on what properties of the objectcan or cannot have user-specified Property Filter Rule expressions.Example: For the Query object in the previous example, the “Block Count”property on the loop may be designated as one for which a user cannotspecify a Property Filter Rule expression. If a Property Filter Rulesupplies one, a warning will be displayed, and the rule will be ignoredat run time.

Similarly, the properties by which the report can be grouped will belimited to those that actually appear in the report and may haveadditional constraints. Example: A Query object that imposes a filter onobjects requiring them to have a specific property value would not allowsorting or grouping on this property.

1.7.2 Using the Report Manager

This section clarifies how objects in the Report Manager are created andused through the IDA applications graphical user interface.

1.7.2.1 Property Filter Rules 1.7.2.1.1 Creating Property Filter Rules

When a new Property Filter Rule is created, it is added as a child tothe “Filters” folder with a default name and the Filter Editor isdisplayed (FIG. 41).

New Property Filter Rules can be created in the following ways:

-   -   Selecting “File|New|Filter” from the application menu.    -   Selecting the “Filters” folder from within the Report Manager        node within the System Hierarchy, and selecting “New” from the        pop-up menu.    -   Clicking on the “Create New” button inside the Filter Editor to        make a copy of an existing filter.

1.7.2.1.2 Editing Property Filter Rules

Property Filter Rules can only be edited from within the Filter Editor,as depicted in FIG. 41. The Filter Editor dialog box allows the user tobuild an expression to evaluate against the property values of aparameterized object type. The Expression builder will let the userbuild simple nested expressions. In some embodiments, users may have theoption of writing a custom expression as a Visual Basic style script torun against the object. This allows more complex relationships amongproperties of the object as well as child or parent objects.

The Filter Editor can be displayed in the following ways in order toedit an existing Property Filter Rule:

-   -   Double clicking the Property Filter Rule to be edited.    -   Selecting the desired Property Filter Rule in the System        Hierarchy, then selecting “File Edit” from the application menu.    -   Right-mouse clicking on the Property Filter Rule then selecting        “Edit” from the pop-up menu.    -   Clicking on the “Edit Filter” button inside the “Filter” tab of        the Report Editor.

1.7.2.1.3 Deleting Property Filter Rules

Property Filter Rules can be deleted in the following ways:

-   -   Selecting the Property Filter Rule to delete, then selecting        “Edit|Delete” from the application menu.    -   Right-mouse clicking on the Property Filter Rule and selecting        “Delete” from the pop-up menu.

1.7.2.2 Composite Report Templates 1.7.2.2.1 Creating Composite ReportTemplates

Only legal Composite Report Templates are created. If the user tries tocreate an invalid one, a warning is displayed and the operation isaborted. Newly created Composite Report Templates are added as childrento the “Report Templates” folder in the System Hierarchy with a defaultname.

New Composite Report Templates can be created in the following ways:

-   -   Selecting “File|New|Report Template” from the application menu        to create an empty Composite Report Template.    -   Right-mouse clicking on the “Report Templates” folder in the        System Hierarchy, and selecting “New” from the pop-up menu to        create an empty Composite Report Template.    -   Selecting one or more existing Report Templates, then selecting        “File|New|Report Template” from the application menu.

1.7.2.2.2 Editing Composite Report Templates

In some embodiments, users can only edit Composite Report Templates. Inothers, users are able to modify a copy of any existing Report Template.What the user is able to modify will be limited to what is allowed bythe Report Template object itself. Composite Report Templates can beedited in the following ways: using the Composite Report Template Editor(FIG. 42); and drag and drop operations in the System Hierarchy.

The Composite Report Template Editor, depicted in FIG. 42, allows theuser to add and remove Report Templates to and from the Composite ReportTemplate. They can also change the Composite Report Template's templateorder and bring up the dialog box used to edit another template.

The Composite Report Template Editor can be invoked by:

-   -   Double-clicking the Composite Report Template    -   Selecting the Composite Report Template, and selecting        “File|Edit” from the application menu    -   Right-mouse clicking on the Composite Report Template, then        selecting “Edit” from the pop-up menu    -   Selecting the Composite Report Template to be edited inside the        listbox control of the Composite Report Template editor, and        clicking on the “Edit Report Template” button.

1.7.2.3 Reports 1.7.2.3.1 Creating Reports

New Reports are added as children to the “Reports” folder in the SystemHierarchy with a default name. New Report objects can be created in thefollowing ways:

-   -   Selecting “File|New|Report” from the application menu to create        an empty Report    -   Right-mouse clicking on the “Reports” folder and selecting “New”        from the pop-up menu to create an empty Report    -   Selecting one or more Report Templates, then selecting        “File|New|Report” from the application menu    -   Selecting one or more objects and dropping them onto a Report        Template

1.7.2.3.2 Editing Reports

Reports can be edited in the following ways:

-   -   Using the Report Editor    -   Drag and drop operations in the System Hierarchy

The Report Editor, depicted in FIG. 43, allows the user to add andremove Report Templates and objects to and from the Report. They canalso pick the Filter to use for the Report and bring up the dialog boxused to edit the filter.

The Report Editor can be invoked in the following ways:

-   -   Double-clicking on the desired Report in the System Hierarchy    -   Selecting the Report, then selecting “File|Edit” from the        application menu    -   Right-mouse clicking on the Report, then selecting “Edit” from        the pop-up menu

1.7.2.3.3 Printing Reports

When a report is printed using the menu, the user can change the printsetup and output printer as well as specify what parts of the Report toprint. Print settings for a Report can be edited by selecting theReport, then selecting “File|Print Setup” from the application menu.

A Report can be print previewed by selecting the Report, then selecting“File|Print Preview” from the application menu.

A Report can be printed in the follow ways:

-   -   Selecting the Report, then selecting “File|Print” from the        application menu    -   Selecting the Report, then clicking the “Print” button on the        application toolbar

Users may also create and immediately execute temporary Reports bydirect manipulation of the objects within the Plant and Systemhierarchies. Note that the default functionality when objects aredropped on a Report Template with the left mouse button is to create anew Report in the Report Manager.

1.7.2.4 Organizational Folders 1.7.2.4.1 Creating Folders

When users have to keep track of a number of Reports, Report Templates,and Filters that they have created, it is convenient for them to be ableto organize them into folders, accessible from the System Hierarchy(FIG. 44). New folders can be created as children of the “ReportTemplates”, “Reports” and “Filters” folders. Users can then move anyReport, Filter, and user created Report Template objects around insidetheir respective parent and user folders but cannot move them to anyother parent or user folder. Standard Report Templates cannot be moved.

New organizational folders can be created in the following ways:

-   -   Selecting “Report Templates”, “Report”, or “Filters” folder in        the System Hierarchy, then selecting “File|New|Folder” from the        application menu    -   Right-mouse clicking on “Report Templates”, “Reports”, or        “Filters” folder, and selecting “New Folder” from the pop-up        menu

1.7.2.4.2 Deleting Folders

Only empty folders can be deleted. Standard Report Template folderscannot be deleted.

1.8 Version Control

Version control in IDA provides the ability for the system to recordchanges made to the control database. It allows the user to be able totell what the state of the system is now, what the state of the systemwas at a specific time in the past, and the history of changes made to aspecific object over time. With IDA version control, the change historyof an object is tracked from the moment it was created through itscurrent version.

The IDA system does this by capturing versions of the objects which makeup an IDA configuration, and providing methods to trace the genealogy ofthose objects forwards and backwards throughout the entire genealogyrepresenting each object's life cycle.

1.8.1 Basic Concepts

Before presenting the object model which has been designed for IDA'sversion control system, a few basic concepts need to be presented inorder to provide a common base of terminology.

IDA version control may be conceptualized as two separate databases (anOffline and an Online database) as depicted in FIG. 45 with the userbeing able to make edits in either database. Synchronization processesare run in order to keep the two databases in synch with each other.

1.8.1.1 Offline Database

Referring to FIG. 54, the offline database contains the configurationdata that forms the basis for the configuration contained in the online,or running, database. A common scenario for a user would be to lock oneor more objects in the offline database (check-out), edit them in apersonal workspace over the course of several hours or days, then placethe changes back into the offline database (check-in). Objects that havebeen modified in the offline database are then manually downloaded tothe target hardware.

Another scenario for editing objects may occur when the user edits asmall amount of data, such as a single block parameter. In edits such asthese, the object will be implicitly checked-out, without the user beingaware, and edits performed on the object(s). When the user is finishedediting the object(s), a simultaneous check-in/download process isinitiated by the user. Edits such as these are meant to cover a shortperiod of time (e.g., minutes) rather than an edit session spanningseveral hours or days.

In either scenario, the download process is responsible for compilingthe modifications to ensure that the edits are valid, and for actuallydownloading the new data to the appropriate control processors. Ifeither the compile or the download to the control processor(s) fails,then the entire download process is rolled back.

1.8.1.2 Online Database

The online database contains the configuration data that has beendownloaded from the offline database, and represents that data which iscurrently running on the control processors. The database, in this case,is not in the same form as that in the IDA database (i.e., it is not anOODBMS), but rather is in a form, e.g., typically proprietary,understandable by the target. As mentioned previously, data isdownloaded from the offline database in a separate process, and compiledto ensure that it is valid for the target processor.

In one embodiment, the user modifies the online database via an externalprocess (not shown). When edits to the online database are done in thismanner, they become out of synch with the corresponding objects in theoffline database. In order to synch the databases back up again, amanual upload process is performed. In this procedure, data is copied toa temporary work area, then compared to the objects which are currentlyin the offline database. Users will manually decide which objects needto be uploaded using a version compare utility provided by theFramework.

1.8.1.3 User Workspace

Users access the IDA system via an editing session. Changes made to IDAdatabase objects accumulate in the user's private edit space, referredto as a user workspace. The user workspace may be thought of as a“mini-database”, containing a subset of the objects contained in thedatabase being modified.

To make a modification to one or more objects, the user locks theobject(s), reserving a copy of the current version of the object(s), andplacing this copy into the user's personal workspace. This copy cannotbe seen by other users of the system. Once locked, an object is onlyavailable for read access by other IDA users. Attempts by other users tomodify the object will result in a dialog box being displayed indicatedthat the object is checked-out, and by whom.

The process of locking the object and placing a copy of it into apersonal workspace is often referred to as checking an object out foredit, or simply check-out.

There are essentially two ways that a user can lock an object.

-   -   An object which is not yet checked out can have a lock applied        implicitly whenever the user starts to edit it. As long as the        object is not already locked by another user, this lock will be        performed automatically.    -   An object can be explicitly checked out, automatically causing a        lock to be applied.

When the user finishes editing the object(s), they are preferably placedback into the appropriate database in order for other users to be ableto see the modifications. This act of placing edited objects back intothe database is referred to as a commit, or check-in, process. Duringthe check-in process, the user may elect to keep the object locked, orto release the lock completely, thereby allowing other users to modifyit once the act of check-in is completed.

An object which has been checked-out may also be explicitlyunchecked-out. This action will release the lock on the object, anddiscard any changes made to it since the last check in. Onceunchecked-out, an object will be automatically removed from the user'sworkspace, and once again become editable by other IDA users andprocesses.

1.8.2 Versioning

As mentioned previously, the various versions of an object could bethought of as multiple self-contained databases (e.g. offline, online)which contain full copies of the configuration, and occasionally need tobe synchronized in order to ensure that edits performed against onedatabase become known in the other.

In reality, the different databases actually simply represent adifferent state, or version, of an object, each version beingrepresented by a distinct instance of the same object. Integral to thisis the concept of the identity of an object. An object's identity (orits address in the database) preferably remains constant throughout thelifetime of the object. If an object's identity was allowed to change asedits were performed against it, it would quickly become difficult tomaintain referential integrity, since everywhere that object wasreferenced would need to be changed. In some embodiments, object ID's(OID's) are as a means of uniquely identifying an object in thedatabase, rather than the pointer or reference which is inherent withthe OODBMS

1.8.2.1 Check-Out

FIG. 46 depicts an object which was created in the offline database, andhas not undergone any modifications (e.g., only version 1.0 is“officially” recognized). A user has checked-out the object (eitherimplicitly or explicitly), causing an IDA-specific Checked-Out attributeto be set on version 1.0 of the object. Once an object is checked-out,the user may make one or more modifications to it, causing theinformation to be stored in the database as version 2.0 of the object,and an edit stamp is created which captures the user-id (among otherthings) of the user who is performing the changes. At this point, theobject may be considered to be in the user's personal workspace.

It is important to note here that version 1.0 is still the currentobject, and that version 2.0 is only visible to the user who has checkedthe object out for modification. This is done primarily via user IDcomparison between the user ID of the user attempting to access theobject, and the user ID contained within the edit stamp.

Until version 2.0 is checked-in, the user may explicitly release thelock on the object being modified via the Revision Editor. When thisoccurs, all accumulated changes made to that point are discarded, theedit stamp is destroyed, and the Checked-Out attribute of the originalobject is reset.

1.8.2.2 Check-In

At check-in (as depicted in FIG. 47), version 2.0 of the object now“officially” exists, and both versions 1.0 and 2.0 get pointers to eachother updated, effectively creating a doubly-linked list to allowtraversal of the version tree for this object. Note that a pointer tothe current object now returns version 2.0, and not version 1.0. Atcheck-in time, the user may optionally keep the Checked-Out attribute onthe object set. Other users now see the modified version, but areprevented from making edits. If the attribute is reset, the edit stamppreviously associated with the object is destroyed.

During a “manual” check-in process, the user is prompted for twoadditional items of information:

-   -   1. For each object being checked-in, the user supplies what        change has occurred to the object to satisfy the reason for the        new version. Only one change “record” will be associated with        each object being checked-in.    -   2. The user is asked for a reason the check-in is        occurring—i.e., the reason for the revision. The same revision        “record” will be associated with all objects being checked-in.

This information will be generated automatically during a minor edit,such as when the user modifies a parameter value.

The Framework provides the application developer the methods necessaryto “walk” the version tree for any versioned object, and to extract thechange and/or revision associated with any particular version of theobject.

1.8.2.3 The Revision Editor

The Revision Editor permits the user to: see a list of all objectscurrently checked-out; record modifications, or changes, made toindividual objects; record a reason for having modified one or moreobjects (a revision); explicitly release locks on one or more objectscurrently checked-out; and initiate a check-in of one or more objects.

A sample user interface for the Revision Editor appears in FIG. 48.

When the user is ready to check objects back into the database, orunlock objects that have previously checked-out, the Revision Editor isinvoked. This editor displays a list of objects which the user currentlyhas checked out. As objects are modified, the actual modification madeto the object can be recorded by selecting the desired object, andentering the change in the edit window labeled “Modification.” Atcheck-in time, if the object(s) hasn't had a change description filedfor it, the user will be prompted to supply that information on aper-object basis.

All the edits which have been performed against an object prior tocheck-in can be discarded by selecting the desired object(s), andchoosing the “Uncheck-Out” button. This effectively deletes the editcopies of the object(s), and their associated edit stamps. TheChecked-Out attribute of the original object is also be reset toindicate that the object is no longer in a checked-out state.

To check an object in, the “Check-In” button on the Revision Editor isselected, resulting in the display of the dialog box depicted in FIG.49. This dialog box prompts the user to supply a label and a “Reason forRevision:” in the edit box. When the user selects “OK”, the new versionof the object officially becomes the current object, and the previouslycurrent object moves downward in the version tree as described in FIG.47. Selecting “Cancel” on this dialog box will result in thecancellation of the revision process.

The user has the option of checking the “Keep Objects Checked-Out”checkbox. If this is checked on when the user selects the “OK” button,the Checked-Out attribute of the new version of the object stays set. Ifthe user does not select this checkbox, all locks to the objects arereleased after check-in, and the edit copy and time stamp associatedwith the object are deleted.

1.8.2.4 A Versioning Example

Taking versioning one step further, there can be several versions of thesame object existing all at the same time (although not all in the IDAdatabase). These versions include: the current offline image of theobject; the current online image of the object; an online edit sessionimage of the object; and multiple previous versions of the object (oneof which may be the current online image of the object).

These versions are represented in FIG. 50.

FIG. 50 (which reads chronologically from bottom to top) illustrates anobject undergoing various edits, each edit establishing a new version ofthe original object. The object is created (version 1.0), and is thendownloaded (Download A) to the target, synchronizing the online imagewith the offline. The user then makes a change to the object in anoffline edit session, then performs a check-in, which creates version2.0. At this point, the online and the offline images are out of sync.Another offline edit produces version 3.0, which is then downloaded tothe target (Download B), and the images fall in sync again.

To illustrate another type of change, the online version is edited viaan external process, which produces version 4.0 of the object. Eventhough the user is able to change the object(s) in the running, oronline, database via the external process, there is no sense ofversioning on the target system. Hence, the external process is notaware that the object is going from version 3.0 to version 4.0—only thatthe objects are different. A new version number is shown in FIG. 50 onlyto visually emphasize that the object has been modified.

In order to synchronize the online and offline images, an upload (UploadC) is performed. The upload process actually places the object(s) in atemporary work file, and then changes which were done in the externalprocess are manually inserted into a checked-out version of the sameobject which is in the user's workspace. The newly-modified object isnow checked-in to the offline database, and the two images are now backin synch with each other.

To finish out the various scenarios in which edits can be made, changescan be made simultaneously to both the online and offline versions of anobject. This is represented in FIG. 50 by an offline edit producingversion 5.0, and an online edit producing version 6.0 of the object.Since edits have occurred in both versions, synchronization isimpossible, and some type of merge operation will need to be done.

The merge operation is a manual process, which is represented by anoffline edit which results in the creation of version 7.0 of the object.Once completed, the object is then downloaded again to the target(Download D), and the online and offline versions of the object are onceagain synchronized.

1.8.2.5 Version Propagation

There are a few cases where a change to an object will propagate to manyother objects. They include block definitions, composite blockdefinitions, and loop template definitions. When one of these definitionobjects is changed, the change preferably propagates to all the objectsthat use the objects definition to define themselves. A version and arevision will be made automatically for each of these objects.

A case can be made in limiting these types of changes to the offlinedatabase. It is doubtful that a change made to a definition should beautomatically “rippled” into a running, online database with potentiallydisastrous effects.

1.8.2.6 Configuring while Disconnected

A feature of the IDA system is the ability to run the system locally ona computer, disconnected from the main IDA database. This feature isintended to allow users to continue configuration activities on computersystems temporarily disconnected from the main IDA database. Users candisconnect from IDA and continue configuring simply by making a copy ofthe entire IDA database onto their local drive, then disconnecting fromthe network. When the user begins a new IDA session, the temporary copyof the database will be opened.

Disconnected users can make changes concurrently with normally connectedusers, and may make changes which conflict with other users. As aresult, when a disconnected user reconnects to IDA, a merge operation ofsome type is effected. That merge operation results in new versions ofthe edited objects, and that the versions will all be associated with asingle revision.

When the user reconnects to the main IDA database, the consistency ofthe object ID's (OID's) is no longer guaranteed, since new objects mayhave been created while disconnected, and others deleted. A macrolanguage, with a record macro feature, helps solve this problem. Theentire disconnected session is recorded as a single macro, and atreconnection time, that macro is played against the main IDA database.Conflicts regarding the consistency of OID's can be minimized by usingGlobally Unique Identifiers (GUID's). A GUID is a 128-bit integer whichis virtually guaranteed to be unique, and is based on the current dateand time, an incremented counter, and a unique IEEE machine identifier.

The macro language is “smart” enough to assert that an object in themain IDA database is unchanged since the start of the disconnectedsession (e.g., by date), and handle the case where an object haschanged. Similarly, the disconnected session playback stops when such adiscrepancy is discovered, allowing the user to properly merge thechange, and then continue on with the playback.

1.8.3 Version Control Object Model

To make a change to a Parameterized Object, the user checks it out intotheir own personal workspace. This may either be done explicitly by theuser, or implicitly. When the first modification to the object iswritten back to the database, an edit copy of the Parameterized Object(and its associated parameters) is created. A temporary Edit Stampcontaining the user ID of the user who checked-out the object iscreated, and associations made between the current version of theobject, the Edit Stamp, and the edit copy of the object (FIG. 51).

During a user's IDA session, if the user ID does not match that of theuser ID contained in the Edit Stamp, only the current version of theobject will be visible. As the user modifies an object in his personalworkspace, a description of the modification may be recorded, andassociated with the object. Note that this provides the “how” of amodification, whereas the revision comment records the “why” of amodification. When the object(s) currently being edited are checked-in,the user is asked to provide a reason for the revision. This revision“record” is permanently associated with the version of each object thatis created as a result of the check-in process.

1.8.3.1 Abstract Workspace

The Abstract Workspace class is used only to provide common data and/ormethods to two specialized subclasses—the User Workspace, and the SystemWorkspace. Being an abstract class, no instances of this class mayexist. The purpose of an instance of the Workspace class is to maintaina list of Parameterized Objects which are contained within it.

1.8.3.2 User Workspace

The User Workspace object, one for each user in the IDA system, containsa list of all the objects which a user has checked out in their personalworkspace. The User Workspace object provides a mechanism by which otherprocesses can obtain a list of objects which have been checked-out byother users, since these checked-out objects would otherwise not bevisible to anyone but the user who has the object(s) checked-out.

User Workspace objects are visible from the System Hierarchy tree view.

Relationships are:

-   -   A User Workspace object is derived from the Abstract Workspace        class.    -   An instance of a User Workspace maintains a list of all the        Parameterized Object that a user has checked-out from the main        IDA database. This User Workspace object is created        automatically when a user is established by Security        Administration, and initialized to an empty state.    -   As objects get checked-in, they get removed from the User        Workspace object (unless the user keeps it checked-out), and        added to the System Workspace object.

When being examined in the System Hierarchy, it is desirable to allowthe User Workspace object “explode” to indicate all of the objects whichare contained within it, representing all the objects that theassociated user has checked-out.

1.8.3.3 System Workspace

There is only one instance of the System Workspace class in the entireIDA system. The System Workspace object contains two lists: one of allthe User Workspaces in the system, and one containing a reference to allobjects in IDA which have been checked-in, but not yet downloaded to atarget platform. The second list is the one which will be referenced bythe Download process developed by the Application group.

The System Workspace is visible from the System Hierarchy tree view.When “exploded”, the System Workspace will display a list of all theUser Workspaces contained within it.

Relationships are:

-   -   The System Workspace object is derived from the Abstract        Workspace class.    -   There is a single instance of the System Workspace class in IDA.    -   The System Workspace object maintains a list of all the User        Workspaces which are in the IDA system. This list gets added to        whenever a new user ID is added to the system via Security        Administration.    -   The System Workspace object maintains a list of all objects        which have been checked back into the IDA database after being        edited, but have not yet been downloaded. As objects get        downloaded, the reference contained by the System Workspace        object is removed.

1.8.3.4 Checked-Out Parameterized Object

An instance of a Checked-Out Parameterized Object is that version of theobject which has been checked out into a user's workspace for editingpurposes. This version of the object does not exist until the first timean update transaction against the object is committed to the database.

When an object is checked-out, an Edit Stamp object is created,containing the user-ID and a time stamp of the time of check-out. Untilthe object is checked-in, only the user with the same ID as the user-IDcontained in the Edit Stamp will be permitted to see the edited versionof the object. Other users will be able to see the current, orchecked-in, version of the object.

When the edits for an object have been completed, they may bechecked-in. At that time, the user has the option of releasing all lockson the object, or keeping the object checked-out. If all locks arereleased, the object is removed from the user's workspace, and is nolonger in a checked-out state. If the user retains the checked-outstatus, other users can see the latest changes to the object, but withread-only access as before. Relationships are:

-   -   A Checked-Out Parameterized Object is associated with an Edit        Stamp, which indicates the date, time and user ID of the user        who has locked the object.    -   When an object is checked-out, a reference to it is placed        within the User Workspace object, so that a complete list of all        objects which are currently checked-out by the user are        available simply by iterating over the contained references.

Since a checked-out version of an object doesn't actually exist untilthe first change is written back to the database, all of theassociations between then User Workspace, Edit Stamp, and Checked-OutParameterized objects can't be created until then.

1.8.3.5 Edit Stamp

The Edit Stamp is basically the user identification, and a time stampwhich indicates the time that a check-out occurred to a ParameterizedObject. Once the user has committed an object being edited back to thedatabase, this information is recorded in a Revision object.

Relationships are:

-   -   An Edit Stamp is associated with one, and only one,        Parameterized Object which has been locked for edit.

1.8.3.6 Checked-In Parameterized Object

An instance of a Checked-In Parameterized Object is that version whichcorresponds to the last committed public version of the object. Thisversion is the view that is open to the public whenever a ParameterizedObject is extracted from the database.

A downloadable object which has been checked-in, but not yet downloadedto its target platform is in a state which needs to be made known to theapplication developer. An object is deemed as being “downloadable” atthe time it is created via its association to instances of the ObjectType class. A reference to these types of objects is added to the SystemWorkspace object is added at check-in time. Downloadable objectsassociated with the System Workspace object are removed from the SystemWorkspace once they have been successfully downloaded to their targetplatform.

When an object is checked-in, the reason for the revision is captured bythe Revision Editor, and a Revision object is created and associatedwith the checked-in object. An object which is checked-in also has aninstance of the Change Description object associated with it.

Relationships are:

-   -   A checked-in version of a Parameterized Object has a Revision        association which reflects the user id, timestamp, and reason        for the revision (who, when and why).    -   A checked-in version of a Parameterized Object has a one-to-one        association with a Change Description object, which records what        modification(s) were made to the object in order to create the        associated revision.    -   A checked-in version of a Parameterized Object maintains a        reference to its Previous Version, in support of the requirement        to be able to “chain” down the version tree of any Parameterized        Object. This would allow an application to get to a version of        any object which existed at a certain point in time.

1.8.3.7 Parameterized Object (Previous Version)

The Previous Version of a Parameterized Object is that version whichcorresponds to the last previously committed public version of theobject. Each Parameterized Object is aware of it immediate ancestor, andits immediate descendant, in the “genealogy” hierarchy. Relationshipsare:

-   -   A Previous Version has a Revision association which reflects the        user id, timestamp, and reason for the revision (who, when and        why).    -   A Previous Version maintains a reference to its Previous        Version, in support of the requirement to be able to “chain”        down the version tree of any Parameterized Object. This allows        an application to get to a version of any object which existed        at a certain point in time.    -   A Previous Version maintains a reference to its Next Version, in        support of the requirement to be able to “chain” down the        version tree of any Parameterized Object. This allows an        application to get to a version of any object which existed at a        certain point in time.    -   As with the checked-in version of the object, a Previous Version        also maintains references to the associated Revision and Change        Description object(s).

1.8.3.8 Revision

A Revision object contains data about who created the revision, atimestamp when the revision occurred, and the reason for the revision. ARevision object also contains a text field explaining the nature of therevision. Relationships are that one Revision object exists for eachversion of each Parameterized Object in the database. MultipleParameterized Objects can reference the same Revision object.

1.8.3.9 Change Description

A Change Description object contains a description of themodification(s) made to an object in support of the associated Revisionlevel. Relationships are that one Change Description object exists foreach version of each Parameterized Object in the database. ChangeDescriptions are unique, and may not be applied to more than oneParameterized Object.

1.8.4 Version Administration 1.8.4.1 Version History

When an object is selected, the user can view its version history. TheFramework provides a utility to display that history, in a userinterface similar to FIG. 52.

If two or more objects are selected, the user needs to select thedesired object from the combobox provided in the dialog box shown inFIG. 52. Once selected, the version history associated with the objectwill appear in the scrolling listbox. Each line in the listboxrepresents a different version of the object, with the modification (orrevision label), e.g., ordered from new to old. By highlighting twoitems listed (they may be non-contiguous), the user may select the“Compare” button and obtain a comparison between the two selectedversions (see next section). Lastly, the user may obtain a report of theversioning displayed in the listbox by selecting the “Print” option, andobtain an output similar to that shown in FIG. 56.

1.8.4.2 Version/Object Comparison

A utility is provided by the Framework which allows the user to comparetwo versions of the same object, or two versions of different objects,and obtain a report detailing those differences. A sample user interfaceto perform this function is presented in FIG. 53.

In this example, the differences between two versions of the same objectis shown. Each version's parameters are listed, along with the value foreach parameter. By selecting the “Next Diff” button, the user isautomatically advanced to the next difference between the two versions(either in parameter name or value). Differences between the two objectscan be outlined (as shown), or appear in a different color. Although notshown in this example, to make this comparison easier, the parameterswill probably need to be sorted alphabetically. Once the firstdifference is viewed, the user will be able to select the “Prev Diff”button in order to move to the previous difference between the twoversions of the object.

This same interface is used to detail the differences between twodifferent objects. The menu command(s) used to provide thisfunctionality are based simply on the fact that two (or more) objectsare selected in the configuration. If more than two objects areselected, a listbox could prompt the user to pick the two objects onwhich to run a comparison.

1.8.4.3 Compacting Version History

Left unchecked, the version control system can consume a large amount ofdisk space. A version control utility is provided in order to reduce theamount of old version information contained within the system, anoperation which may be referred to as compaction. Generally speaking,compaction consists of two distinctly different operations:

-   -   1. Collapse. This operation removes version information between        two dates. Intermediate versions are deleted, and revisions        during the collapsed period are concatenated. Typically, a        system is collapsed as a major change (which may require several        intermediate check-out and check-in cycles) is commissioned. A        collapse at that time acts to delete the details of the changes        done during the development phase, while retaining the overall        revision and change information.    -   2. Trim. This operation removes version information before a        certain date. This operation will remove both version and        revision information, acting to slice off all history before a        specific time.

1.8.4.4 Version Baselining

There may be a need for all objects in an IDA configuration to becomebaselined, or tagged with a revision label which is common for allobjects. It might be convenient to baseline a configuration, forexample, just prior to an historical archive, or just before a bigconfiguration change is about to be implemented.

The Framework provides the user with a mechanism for baselining an IDAconfiguration. The resulting revision and change information iscaptured, and each versionable object in the database is versioned witha common revision. The information associated with baselining (i.e. acommon revision label) can be used as a basis for rollback.

The concept of baselining can be extended to only selected objects,rather than the entire database. For example, a user may want tobaseline all the objects associated with a certain plant section. Inthis scenario, the user selects the desired plant section in the PlantHierarchy, and select “Baseline” from a right-mouse click, pulldownmenu. After capturing the change and revision information, all theobjects associated with the selected plant section would beautomatically versioned with the baseline information.

1.8.4.5 Historical Archival

The version control features described above are database operations—theentire history of all the changes done to each IDA configuration objectis contained within the database. Archiving change history is done usingvendor-provided backup utilities (e.g., for ODI's ObjectStore, theutility osbackup). These backups are meant to be special historicalbackups rather than the ones associated with normal day-to-day systemoperations.

As noted in the next section, and depicted in FIG. 54, depending uponhow rollback is implemented, a playback macro is archived at the sametime that the configuration is archived, and a new macro initialized toan empty state in preparation for ongoing changes to the now-archiveddatabase. In this manner, the playback macro of a database representsthe total changes which occurred to a configuration from one historicalarchive to the next.

1.8.4.6 Archive Retrieval and Rollback

A rollback provides database auditors with a means of viewing thedatabase at a particular date and time. There are at least three ways inwhich some degree of rollback can be accomplished, all of which createthe rolled-back version of the database separately from the currentoffline database for obvious reasons.

1. Archive Retrieval. This is by far the simplest way to institute arollback mechanism, but it has drawbacks. In this scenario, the userspecifies the archive to retrieve, and the database is restored to thestate which it was in at the time the archive was created. Adisadvantage to this method of rollback is that the user may actually beinterested in the state of the configuration at a point in time betweentwo archives, with no way of getting there.2. Macro Playback, or Roll Forward. This method utilizes a concept whichwas first discussed in the section dealing with modifying aconfiguration while disconnected from the main IDA database (e.g. on alaptop computer), and is probably preferable in terms of being able toimplement than the other two methods. This method requires an additionalcomponent to the historical archive mechanism itself—that of a recordmacro which is initialized following each time an historical archive iscreated. This macro records the changes made to the database in detailrich enough to be able to reproduce those changes. The record macro isarchived on the same media that the database is stored on at the timethe archive is created.

Referring to FIG. 55, when the need for a rollback is identified, thearchive nearest in date to the desired rollback date, but not later thanthe rollback date, is restored to a database. The record macroassociated with that archive is then “played” back, creating changes tothe temporary database just as though a user were performing the edits,forward to the date that the user specified for rollback. When the macroplayback has finished, the database is in the state that it was at thedate specified.

This technique permits enough detail to be recorded to reproduce allchanges to all objects, regardless of whether they were versioned ornot. This automatically allows changes such as associations betweenobjects to be re-established, since they are created in the same order,and by the same method, that they were in the original database. Thereis minimal danger in the method resulting in “dangling” relationships,or “orphaned” objects.

3. Rollback. This method is the most difficult to implement, and canpotentially corrupt the data. In this scenario, the user provides a dateto be used to determine how far to roll the database back.Alternatively, the user might supply a revision label which was providedduring a baseline operation, in order to establish the point in timethat the rollback is to address. The rollback utility is offline, andrelies on the historical backups which were described in the precedingsection. When a rollback is desired, the appropriate archive is restoredto a separate system, isolated from the running IDA database. Therollback utility is then run against the restored archive. The rollbackutility walks through the entire IDA database, using the versioninformation to roll the objects back to the requested date and time. Atthat point, an image of the database exists as it did on the requesteddate.

1.8.4.7 Audit Trail

A utility is provided which allows the user to produce an audit traildetailing the changes and/or revisions which have occurred on selectedobjects over a period time. The functionality of producing an audittrail lists the individual changes which have been recorded from oneversion of the object to the next. The process would begin with theoldest version of each selected object, and traverses the version treeof the object, output the change records associated with each succeedingversion. The resulting report could appear as FIG. 56. The informationof interest includes the version number, the date that each version wasmade, who made the version, the nature of the modification (change), andthe reason for the modification (revision). A modification of thisreport (or interface) suffices for any audit trail requirements whichhave been imposed on IDA. If this is the case, then the audit trail forany object(s) can be produced on demand, rather than kept up-to-dateeverytime a modification to an object is made.

1.9 Undo Manager

The Framework provides a basic Undo/Redo capability in the form of anUndo Manager for IDA application developers.

The purpose of the Undo Manager is to allow users to undo changesthey've made to objects if they decide they don't want those changes.The Undo Manager enables multi-level undo and redo operations foractions which have been defined for each object by the applicationdeveloper. Each developer is responsible for creating the undo units(i.e. actions) which mean something to the object. Undo units may benested hierarchically (i.e., undo units can contain other undo units),resulting in a parent undo unit. This allows complex operations such asa change on a multiple selection to be treated as a single undoableaction.

The Undo Manager provides a centralized undo/redo service, managing bothsimple and parent undo units on the undo and redo stacks. Undo units aretypically created in response to actions taken by the end user, or aprogrammatic function which is simulating a user-generated action. Whenan object's state changes, it creates an undo unit encapsulating all theinformation it needs to undo that change. The object then calls methodswithin the undo manager to place the corresponding undo units on thestack. The Undo Manager then has all the data it needs to support theundo/redo user interface.

1.9.1 Object Model 1.9.1.1 Undo Manager

The Undo Manager manages two stacks, the undo and redo stacks, each ofwhich is a repository for undo units generated by application software.When an object's state changes, it creates an undo unit encapsulatingall the information necessary to undo that change, and passes it to theUndo Manager. The Undo Manager, depending upon what state it's in, willplace the undo unit on the undo or the redo stack, as appropriate.

When the user select Undo, the Undo Manager takes the top unit off theundo stack, invokes it, then discards it. Similarly, when the userselects Redo, the Undo Manager take the top unit off the redo stack,invokes it, then discards it.

The Undo Manager has three states: the base state, the undo state, andthe redo state. It begins in the base state. To perform an action fromthe undo stack, it puts itself in the undo state, invokes the action,then returns to the base state. To perform an action from the redostack, it puts itself in the redo state, invokes the action, thenreturns to the base state. If the Undo Manager receives a new undo unitwhile in the base state, it places the unit on the top of the undostack, and empties the redo stack. If it receives one while in the undostate, it puts incoming units on the redo stack. Finally, if it receivesa new unit while in the redo state, it places them on top of the undostack without flushing the redo stack.

The object model depicted in FIG. 57 shows a subclass of the UndoManager (the IDA Undo Manager). This subclass extends the Undo Managerto be aware of the current modification state of the MFC document whichthe instance of the Undo Manager is associated with. Depending upon thestate of the Undo Manager, the modified state of the document may needto be changed programmatically. For example, if the user performs Undoand empties the undo stack, essentially no changes have been performedto the configuration. The document associated with the application,however, is not aware of that, and will continue to indicate a modifiedstate unless reset.

1.9.1.2 Undo Unit

An Undo Unit encapsulates the information necessary to undo (or redo) asingle action. Its principal methods are Do( ) and GetDescription( ).The Do( ) method implements the actual undo (or redo) operation. CallingDo( ) on an undo unit in the undo stack creates a corresponding(inverse) object on the redo stack, and vice versa. The GetDescription() method returns a description of the unit, used to edit menu text(e.g., Undo Color Change, etc . . . ). There are two subclasses of UndoUnits: simple and parent.

1.9.1.3 Simple Undo Unit

A Simple Undo Unit contains the information to undo a single operation,such as creating or moving an object. Simple Undo Units preferably donot change the state of any object if they return failure. This includesthe state of the redo stack (or undo stack if performing a redo). Theyare also used to put a corresponding unit on the redo (or undo) stack ifthey succeed.

1.9.1.4 Parent Undo Unit

A Parent Undo Unit can also contain other Undo Units. This becomesuseful when the user performs a complex action, yet perceives it as asingle action. For example, the user might select several objects on thescreen all at one time, and move them as a group to some other location.To support an undo of this type of behavior, the Undo Manager preferablyhas a single undo unit which encapsulates all the actions of all theseobjects.

The Parent Undo Unit has two methods, Open( ) and Close( ) which providethe encapsulation. Simple Undo Units are added to parents by an Add( )method. Parent units are added through Open( ), which leaves the unitopen. In this way, Parent Undo Units keep simple ordered lists of childunits. Each Parent Undo Unit is responsible for managing the child unitsit receives through the Open( ) or Add( ).

Parent Undo Units preferably do not change the state of any object ifthey return failure. Additionally, if one or more children succeededprior to another child's failure, the parent unit preferably commits itscorresponding unit on the redo stack, and return the failure to itsparent. If no children succeeded, then the parent unit only has tocommit its redo unit only if a state change has been made which needs tobe rolled back.

1.10 Users and Security

The Framework provides security functions to allow users and otherpersonnel to restrict access to objects which need to be protected fromunauthorized modification or access. User-level security is optional,and is disabled by default. Implementation-standard security restrictsmodification of implementation-standard standard objects (such asstandard I/A Block definitions) to authorized personnel, and ispreferably always enabled.

When user-level security is enabled, the security functions provideauthentication by presenting a log-in dialog requesting a user name andpassword when a user starts any IDA application. Similar to the WindowsNT security model, access control is provided by assigning users togroups which have various access permissions (read, write, create,etc.). Groups are based on roles, such as Process Engineer or AdvancedOperator, and users can assume multiple roles by being assigned tomultiple groups. Implementation-standard default groups and permissionsare provided, but users can create their own groups, and can modify thepermissions of the default groups. Permissions are assigned by objecttype (such as Loops) and by Plant Area (such as East Plant Section).This provides selective access by geographic area.

A switch user/group function is also provided which allows users toassume a subset of their permissions or allows another user totemporarily log-in. Users use this function to assume a more restrictiveset of permissions to ensure that they do not make an inadvertent changeif they were only interested in viewing configuration data. The abilityto temporarily log-in would be used to allow a supervisor to assistanother user in making changes which may require special accesspermission to an existing configuration work space, and then returncontrol to the original user.

The Framework supplies user interface dialogs to allow developers toregister objects and permissions to assign permissions to the defaultgroups. The Framework also supplies an API to allow the variousconfigurator applications to check for access permission beforeresponding to access requests for objects they control. A consistent“access-denied” mechanism will be provided to advise the application ofa security access violation.

1.10.1 Object Model

IDA uses a security system to control access to configuration objects byusers. Given a particular user and a particular object, the securitysystem determines what permissions the user has (e.g. read, write) withrespect to the object. The security object model is depicted in FIG. 58.

1.10.1.1 Group

In the Security model, the Group object is used to categorize Users,with many instances of Users belonging to the same Group object (e.g.,Operator, Engineer, etc.). These broad categories are each associatedwith a specific set of permissions. These permissions pertain to variousareas throughout the plant, as well as to object types within the plant.

Instances of Groups may form a hierarchy, and contain other Groups(e.g., Test Operator within the Operator Group). However, an instance ofa Group can only be contained by one, and only one, other Group. Forexample, the Test Operator group could be in the Operator group, but notalso in the Engineer group. Each Group has permissions of its containingGroup, and may add additional permissions. See “Users and GroupsExample” in FIG. 59.

Members of a Group can have permissions objects via the object'sassociation to instances of the Process Area and Object Type classes. Tohave a permission to access an object within a Process Area, the grouppreferably has that permission to both the Process Area, and the ObjectType. If the object is not assignable to a Process Area, then the grouponly needs type permission against the object in order to access it.

In summary, relationships are:

-   -   A Group object maintains a list of all User objects associated        with it.    -   A Group object maintains a list of all other Group objects which        are contained within it.    -   A Group object can be in only be directly related with one other        Group object (i.e., Groups can occur in only one place in the        Group hierarchy)    -   A Group object has all the permissions of its containing Group,        and may have additional permissions.    -   User objects within a Group object access objects assigned to        specific Process Areas if that Group has permission to do so.        Since permissions form a hierarchy, it's possible for a Group to        have multiple object permissions within the same Process Area,        as well as permission to access objects in multiple areas. This        relationship is managed by the class Area Permissions.    -   Similarly, User objects within a Group object can access many        different types of objects. Since permissions form a hierarchy,        it's possible for a Group object to have multiple permissions        within the same Object Type, as well as permission to access        different Object Types. This relationship is managed by the        class Object Type Permissions.

Listed below are sample Groups provided with one embodiment of theinvention:

Group Title Group Description Advanced Operator Tuning specialized orcritical loops. Default User General user capabilities to read, but notchange configuraton data. Developer Develop and maintain IDA frameworkand applications which run inside the framework. Note that thisparticular group object may not be visible to a “normal” user. OperatorTuning general loops. Process Engineer Build and maintain process loopconfigurations. Process Engineer Administrator Develop and approvecustomer default block parameters, loop templates, proprietary controlschemes, batch administration, etc. Software Engineer Develop andinstall customer applications and third party software, such as customreports and database applications. System Administrator Configuresystem, security, backups, fault tolerance, etc.

1.10.1.2 User

In IDA, a User object is someone who initiates an Edit session using aunique identifier. This identifier is captured from within the Frameworkin order to determine security permissions. A User preferably belongs toat least one Group. A User may belong to more than one Group, limitedonly by the number of Groups defined in the system. When a User logsonto IDA initially, they acquire the sum of the permissions of all oftheir associated Groups. Since a User can belong to different Groups,they should be able to change which Group or Groups they belong todynamically (refer to FIG. 62). The groups which a User belongs to atany point in time is referred to as the Active Group Set. The ActiveGroup Set will be used for determining permissions. The permissionswhich a User has at a specific point in time are determined by the sumof the permissions of all the Groups within the Active Group Set. A Usercan change groups at any time, but only to groups within the set whichhave been defined for him in the Group hierarchy. Summarizingrelationships:

-   -   A User object belongs to one or more Group objects in the        security hierarchy. Groups objects, in turn, maintain a list of        all associated User objects.    -   A User object is able to dynamically change its Active Group        Set, thereby changing the permissions by which the User object        can access objects within IDA.

Users and Groups form a hierarchy as illustrated in FIG. 59. A Group canonly be in one other Group, so that for example, Test Operators couldnot appear more than once in the hierarchy.

In the example shown in FIG. 59, the group “PE Administrator” has all ofthe permissions of “Process Engineer”, and may have additionalpermissions. Note that user “User X” belongs to both the “ProcessEngineer” and “Advanced Operators” groups.

1.10.1.3 Process Area

Instances of the Process Area class form a hierarchy, and reference suchthings as individual buildings, or areas within a building in whichlogically-related processes are performed. Process Area objects cancontain other Process Area objects, and they can be associated with oneor more configurable objects which are capable of being assigned to thatProcess Area. Examples of such configurable objects are Loops andCompounds. Each instance of a Process Area object has permissions of itscontaining Process Area, and may add additional permissions.

Objects may be indirectly associated with a Process Area. For example, aBlock may be associated with a specific Process Area as the result ofbeing part of a Loop or Compound associated with that area. Theramifications of this on the design needs to be explored further.

Summarizing Relationships:

-   -   User objects within a Group access objects assigned to specific        Process Area object if that Group object has permission to do        so. Since permissions form a hierarchy, it's possible for a        Group object to have multiple permissions within the same        instance of the Process Area class, as well as permission to        access objects in multiple areas. This relationship is managed        by the class Area Permissions.    -   An instance of a Process Area can contain other Process Areas.        Permissions are “inherited” from the containing Process Area.    -   Configurable objects can only belong to a single instance of a        Process Area (i.e., an object can't belong to two or more        Process Area objects at the same time).

1.10.1.4 Area Permission

The Area Permission class is used to restrict a user's access to anobject by considering where the object resides in the plant hierarchy.Area Permission objects allow system administrators to set user accesspermission to the objects assigned to Process Areas by groups that theuser belongs to. Area Permission objects contain a reference to thepermission in the permission hierarchy for the indicated Group/ProcessArea object pair. Summarizing relationships:

-   -   An Area Permission object represents the permission in the        permission hierarchy that the associated Group has on objects        which have been assigned to the associated Process Area.    -   Permissions get more restrictive, not less, as you go down the        area hierarchy.

1.10.1.5 Assignable Object

An Assignable Object is an instance of an object associated with anObject Type (refer to object model depicted in FIG. 13) capable of beingassigned to a Process Area. One or more instances of Assignable Objectmay be assigned to the same Process Area object. Objects associated withan instance of the Object Type class are deemed “assignable” when theyare created. Access to an Assignable Object is dictated first by theuser's group access to the object's type, then by the user's groupaccess to the Process Area object which the object has been assigned to.Summarizing relationships:

-   -   An Assignable Object can be assigned to one, and only one,        Process Area object. The object maintains a reference to the        Process Area to which it has been assigned.

FIG. 60 depicts the hierarchical relationships between instances ofProcess Areas, and Assignable Objects.

1.10.1.6 Object Type Permission

Instances of the Object Type Permission class control access to objectsby considering what type they are. Object Type Permission objects allowsystem administrators to set user access permissions to the object typesby groups that the user belongs to. Object Type Permission objectscontain a reference to the permission in the permission hierarchy forthe indicated Group/Object Type pair. Summarizing relationships:

-   -   An instance of the Object Type Permission class represents the        permission that the associated Group object has on objects of        the associated Object Type.    -   User objects within a Group may access many different types of        objects. Since permissions form a hierarchy, it's possible for a        Group object to have multiple permissions within the same Object        Type, as well as permission to access different Object Types.        This relationship is managed by the class Object Type        Permissions.

1.10.2 Security Administration 1.10.2.1 Permissions Hierarchy

Permissions (both Process Area and Object Type Permissions) for IDA forma hierarchy defined by static data within IDA, and not allowed to bechanged by the user (FIG. 61). General read and write permissions willneed to be more fine grained than simply read vs. write. Permissionsstated in the Process Area Permissions and Object Type Permissionsobjects are stated in terms of one of the higher entries in thehierarchy, but can be as fine grained as needs dictate.

1.10.2.2 Download Permission

Download permission governs who is allowed to download configurationdata to the targeted I/A system. The download is the process by whichedited configuration information gets transferred to the target. Adownload permission is a special case of IDA security—althougheffectively it is only an IDA database read, the fact that it affects arunning target makes it special. As with other permissions, downloadpermissions may be set on an object type basis, and/or on process areas.

1.10.2.3 Switch Group/User Facility

A mechanism by which a user can switch groups is provided in IDA. Themechanism allows a user to perform the majority of his daily operationswith a default minimal security setting, then switch to a morerestrictive security setting by changing the Active Group Set they arecurrently associated with.

Another mechanism allows the user to switch user ID's. This isaccomplished by the same mechanism described above. The mechanism wouldalso allow a supervisor to temporarily “log-in” to a user's session,perform a restricted operation, then “log-out” and return security (anduser ID) to its previous settings. A simple dialog box like the onepresented in FIG. 62 is provided to perform this switching.

In the example shown in FIG. 62, User X is currently logged in, and hasactivated the Switch Group/User Facility. The application will allowUser X to select (or deselect) Groups which he is currently allowed tobe associated with, thereby establishing his Active Group Set.

Notice in the sample dialog that some groups are dimmed, or“greyed-out”. These groups represent those groups which are notcurrently in the user's Active Group Set. Clicking on the text of aGroup will toggle it back and forth between the normal “on” state, andthe dimmed “off” state. This is only an indication of the functionalitywhich is used in the illustrated embodiment, not a restriction on otherimplementations.

Additionally, by selecting the “Switch User” pushbutton, a screenequivalent to the log-in screen appears, prompting for a new user's IDand password. This user ID would be “stacked”, in that IDA remembers theprevious user ID as a new one logs in, so that when the new userfinishes an edit session and exits, they will effectively be revertingback to the original user's identity and permissions. A user stack ofonly one-deep will suffice for this purpose.

1.10.2.4 Managing Groups and Users

This section presents sample property pages which used to maintaingroups and users. All dialogs presented in this section are meant to beused in the performance of ongoing Security Administration.

The first property page presented in FIG. 63 represents a way in whichthe security administrator manage Groups. The existing Group structureis placed into a type of tree hierarchy control, which isimploded/exploded as necessary to gain an entry point into the Grouphierarchy. To add a new Group, the administrator finds the proper spotin the control where the new Group could be inserted, and press “NewGroup”.

At that time, a dialog box (not shown) pops up, prompting theadministrator for information to create a new Group. Upon exiting thatdialog, the new Group is displayed at the proper point in the hierarchy.A Group automatically inherits all Object Type and Area Permissionsassociated with its root Group.

To add new users to IDA, the security administrator presses the “NewUser” button, and a dialog box (also not shown) pops up, prompting theadministrator for any information IDA requires to establish a User. Thisinformation contains the User's name, password, and possibly some otherinformation which is needed for administrative purposes by IDA. Uponexiting the dialog, the new User will have been established as a validUser within the IDA administrative system, but not yet assigned to aspecific Group (or Groups). To assign a new User to a Group, or modifythe Groups to which an existing User belongs, the administrator wouldselect the “Users” tab on the property sheet.

In this example (shown in FIG. 64), the administrator is able to selectthe User from the combobox depicted by “User ID”. Once the User wasselected, the administrator would be able to modify their passwordand/or description in the edit fields provided, and pick the Group(s)that the User would need to be associated with.

And finally, the following property page shown in FIG. 65 represents amethod by which Group access, or permission, could be given to specificObject Types. In this example, the administrator picks the Group andObject Type to be “linked” together via a permission, then picks from alist of available permissions all those which apply for this Group. Themechanism allows for permissions to be added, as well as deleted.Permissions can be established at any level in the Permission Hierarchy,since the Permission Hierarchy is allowed to be as fine-grained asnecessary for the customer's unique requirements.

1.10.2.5 Managing Process Areas

This section presents sample property pages used to maintain processareas. All dialogs presented in this section are meant to be used in theperformance of ongoing Security Administration.

The property page shown in FIG. 66 represents a way in which thesecurity administrator manages Process Areas. The existing Process Areahierarchy are placed into a type of tree hierarchy control, which isimploded/exploded as necessary to determine an entry point into theProcess Area Hierarchy. To add a new Process Area, the administratorwould find the proper spot in the control where the new area is to beinserted, and press “New Area”. At that time, a dialog box (not shown)pops up, prompting the administrator for information to create a newProcess Area. Upon exiting that dialog, the new Process Area isdisplayed at the proper point in the hierarchy. When a Process Area isfirst created, it will automatically inherit all Assignable Objects, andArea Permissions associated with its root Area.

And finally, the following property page in FIG. 67 represents a methodby which Group access, or permission, could be given to specific ProcessAreas. In this example, the administrator picks the Process Area andGroup to be “linked” together via a set of permissions, then picks froma list of available permissions all those which apply for this ProcessArea/Group combination. Permissions can be established at any level inthe Permission Hierarchy, since the Permission Hierarchy is allowed tobe as fine-grained as necessary for the customer's unique requirements.

1.10.2.6 User Authentication Service

Closely associated with the IDA security subsystem, but separate, is aUser Authentication Service. This service is responsible for providingthe security service with the identity of an authorized user of the IDAsystem. The authentication service is responsible for providing theapplication's security mechanism with the name of an authorized user.Whenever the security system needs to evaluate a user's permissions toan object, it will ask the authentication service for the name of theuser. The first time this happens, the authentication service queriesthe operating system for the name of the user, and responds with thename of that user. The name is then cached for use in later calls.

Another implementation results in the user being presented with a“login” dialog box asking for a username/password combination the firsttime the authentication service is asked for the name of the user.Again, the user's name, once captured and verified, is cached for lateruse. This implementation is desirable in certain I/A installations inwhich all users commonly log-in as “root” or “administrator”, making anoperating system query for the name of the user meaningless.

Part 2—Control Algorithm Configurator Architecture 2 Functions

This section describes major functions of the configurator architecture,including sample user interface representations. Note that these userinterface sample are intended to illustrate functionality described inthe text and are not intended to show all design details, such as menusand toolbars. In the object model diagrams included in this section,shading indicates classes supplied by the IDA Framework and a dashedline border indicates classes described in another subsection of thisdocument.

2.1 Project Manager/Navigator Interface 2.1.1 Overview

The Project Manager is the navigator's view into the project database.It allows the user to browse through the project configurationhierarchies and data. The GUI interface is similar to the MicrosoftExplorer's look and feel. The Framework described in Part 1 provides acommon Project Manager navigational capability. This section describesthe functionality specific for Control Algorithm Configuration.

2.1.1.1 System Tree View

FIG. 68 shows the Navigation Manager's System Tree View. The Componentsitem holds the main items involved in control configuration: ControlLevels (shown as compounds in the figure), Control Algorithm Diagrams(shown as Loops in the figure), and processors.

2.1.1.2 Control Algorithm Diagrams

The Control Algorithm Diagram Editor supports adding and connectingblocks to specify control algorithms. Blocks are only created throughControl Algorithm Diagrams. The blocks in a Control Algorithm Diagrammust preferably be assigned to a Control Level. A default Control Levelmay be set for a Control Algorithm Diagram, setting all blocks in thediagram to that level. However, blocks may be reassigned to any ControlLevel.

2.1.1.3 Control Processors

Control processors execute the control applications created by theusers. The blocks specifying the control application are containedwithin the control processor in Control Levels. The Control Levels areassigned to Control Processors.

2.1.1.4 Control Levels

The Control Levels act as a logically named container for controlapplications. Within control processors, the control algorithm blocksare contained in Control Levels. The control levels provide a hierarchystructure following the IAS S88 standard. This standard defines sevenlevels of plant hierarchy with each level serving as a logical containerfor the next lower level.

Enterprise

-   -   An organization that coordinates the operation of 1 or more        sites    -   May contain 1 or more Sites

Site

-   -   A physical, logical, or geographical component of the enterprise    -   May contain 1 or more Areas

Area

-   -   A component of a site identified by physical, geographical or        logical segmentation    -   May contain 1 or more Process Cells

Process Cell

-   -   Defines the span of logical control of one set of process        equipment within an area    -   Preferably contain 1 or more Units

Unit

-   -   A collection of associated control modules and/or equipment        modules in which 1 or more major processing activities can be        conducted    -   May contain 1 or more Equipment Modules

Equipment Module

-   -   A functional group of equipment that can carry out a finite        number of specific minor processing activities    -   May contain 1 or more Control Modules

Control Module

-   -   The lowest level of equipment that can carry out basic control

The control naming hierarchy implemented by IAS does not address the toptwo levels of the ISA S88 hierarchy. The control hierarchy begins withthe “Area”. In addition to the ISA S88 hierarchy, the implementationdefines three additional levels: blocks, parameters, and attributes.Every level of the naming hierarchy may contain blocks. There is norestriction that only the “Control Module” level contains blocks.

2.1.1.5 Control Level Syntax and Assignment Rules

The following rules characterize the naming hierarchy:

-   -   Total name length of 128 bytes, including delimiters    -   A total of 32 bytes for each level name    -   The name can be any mix of numeric (0-9) or alphabetic (A-Z)        characters and the underscore (Internationalization issues are        not currently decided)    -   Names may not contain spaces    -   Each naming level, except possibly the last, is a compound. Each        level may contain:        -   Other levels        -   Blocks        -   Parameters    -   A delimiter using the greater than symbol (‘>’) between levels    -   There is no delimiter before the first level name    -   A delimiter of colon (‘:’) between a level and a block    -   A delimiter of period (‘.’) between a block and a parameter    -   A delimiter of period (‘.’) between a parameter and an attribute    -   At a given level, the names of any contained levels must        preferably be unique    -   At a given level, the names of any contained blocks must        preferably be unique    -   At a given level, names for blocks, levels, and parameters do        not have to be unique between themselves.    -   The full naming hierarchy does not have to be used.        -   At least one level must preferably be specified. This            provides compatibility with I/A naming            convention—compound:block        -   Any number of levels up to the maximum may be used

Given these rules the following two names specify blocks:

Area1>ProcCell2>Unit1>Equipment1>CtlMod2:FT104.STATUSArea1>ProcCell2>Unit1:CTLBLOCK.STATUS

-   -   The first name defines a block named FT104 with a parameter of        STATUS.    -   The second name defines a block named CTLBLOCK with a parameter        of STATUS.    -   The FT104 block is contained within the Control Module level.    -   The CTLBLOCK is contained within the Unit level.

Since names for blocks, levels, and parameters do not have to be unique,the following is legal:

Area1>ProcCell2>Unit1>Equipment1>CtlMod2:FT104.STATUSArea1>ProcCell2>Unit1.STATUS Area1>ProcCell2:Unit1.STATUS

-   -   The ProcCell2 level contains a level called Unit1    -   The ProcCell2 level contains a block called Unit1    -   The Unit1 level contains a parameter called STATUS    -   Each of these objects can be uniquely resolved.

Names do not have to span the full naming hierarchy:

-   -   Area1:FT104.MEAS

This provides with backward compatibility with I/A names

-   -   Compound:Block.Parameter

A second set of rules specify the relationships to control stations:

-   -   Blocks are never directly assigned to control stations    -   Blocks are assigned to compounds expressed as a level name    -   The compounds, or levels, contain not only blocks but also other        compounds    -   The compound, or levels, also contain parameters    -   Each level contains a parameter that allows the grouping of        contained blocks, and blocks within contained levels, for shared        name scope in structured text programs, the unit grouping flag.    -   Once the unit grouping flag is enabled, the unit grouping flag        in contained levels is ignored.    -   Compounds, or levels, are assigned to control stations    -   Any level, regardless of it's position in the hierarchy, may be        assigned to a control station    -   All contained levels are also assigned to the control station        when a level is assigned to a control station    -   Contained levels may be reassigned to a different control        station. Lower levels contained by the reassigned level are also        reassigned    -   Contained levels may not be reassigned to a different control        station if the unit grouping flag for a parent level is set. All        lower levels contained by the reassigned level are also not        allowed to be reassigned    -   All referenced levels are preferably assigned to a control        station    -   All blocks assigned to a level preferably execute within a        single control station.    -   Although contained levels may execute in a different control        station, all of the blocks at a given level preferably execute        within the same control station. (All blocks in a compound        execute in the same control station.)    -   More than one level may be assigned to a CP    -   More than one level which are at the same point in the hierarchy        may be assigned to a control station (i.e. Area1 and Area2 may        both be assigned to the same control station)    -   The block processing order is a function of the control station        and is specified in control station documents.

The levels in a control hierarchy are not only divisible between controlstations in a child relationship; they can also be divided among parentcontrol stations:

Area2>ProcCell1 assigned to CP001 Area2>ProcCell2 assigned to CP003 ORArea2>ProcCell1>Unit1 assigned to CP001 Area2>ProcCell1>Unit2 assignedto CP003

All of the blocks contained by a level (a compound) preferably executein the same control station.

Area2>ProcCell1>Unit1:FT104 If block FT104 executing in CP001Area2>ProcCell1>Unit1:FT105 then block FT105 preferably also executes inCP001 Area2>ProcCell1>Unit1> block FT106 could Equipment1:FT105 executein a separate CP

All compounds and all blocks could be assigned to a single controlstation

Area1 Assigned to CP003 Area2 Assigned to CP003

Any level could be assigned to a control station

-   -   Area2>ProcCell>Unit1>Equipment1>CTLMod1 assigned to CP003

All used levels are preferably assigned to a control station

Area2 > ProcCell1 assigned to CP003 Area2 > ProcCell2 assigned to CP001

If these are the only two assignments made, then

-   -   Area2 is not assigned to any control station, this is illegal

2.2 Block Definition Editor 2.2.1 Overview

The Block Definition Editor allows control blocks and their parametersto be defined for use on IAS. Through the editor, users create entirelynew block definitions or derive new blocks from existing definitions.Only blocks derived from implementation standard control blocks downloadto control stations. User-defined blocks also appear in the list ofdefined blocks when viewed with this or the Control Algorithm DiagramEditor, but are not installed into a control station. This list containsonly single Block definitions; no Composite Block Definitions appear.

FIG. 69 shows the main display for the Block Definition Editor. The useris presented with the Project Manager tree branch representing thehierarchy of block definitions. All block definitions derived from thebase types show as lower branches in the tree. A grid view shows theparameters for each block. Each row is a block parameter with thecolumns representing the parameter attributes. The attribute values foreach parameter can be modified by the user. However, some inheritedparameters cannot be overridden in the derived block definition:parameter name, value type, etc. Values that are overridden aredisplayed differently from those defined in the local block definitionor in the parent block definition. Both the tree and grid views arebased on Framework supplied editor classes.

Definitions for derived blocks can add parameters or modify theattributes of inherited parameters, but inherited parameters cannot beremoved. Blocks are derived from exactly one other block definition.

The user cannot modify the implementation-standard blocks. This blockset is part of IDA. Personnel with the appropriate security permissionscan add, modify and remove any parameters when creating the standard setof IAS blocks. Users can add parameters to definitions derived fromthese standard block definitions or create new “base” block definitions(not derived from an IAS block type). The first four rows in FIG. 69show examples of user-added parameters in the Block Definition for blockAIN2. These parameters are available for documentation and calculationpurposes only, but are not downloaded into running control stations.

There are two classes of parameters, those that are integrated directlywith the control system (control parameters) and those that are not(non-control parameters). Control parameters are those downloaded toControl Processors and participate in the running of the control system,such as parameters associated with the standard control block types AIN,PID, AOUT, etc. Non-control parameters can be used for calculations,documentation, etc. and are not downloaded to the CP. Normal users canonly add non-control parameters, only authorized personnel (e.g.,engineers) can add control parameters.

Each parameter in a block definition contains a fixed set of predefinedattributes. Values can be given to all of these attributes in the blockdefinition where the parameter is defined. A subset of these parameterattribute values can be changed in derived blocks, which results in thecreation of a parameter override object being created.

The value of a parameter can be defined in two ways—by setting the“value” attribute to a constant value or by setting the “formula”attribute to a formula. In the “value” attribute of a parameter, userscan supply constant default values for parameters in block definitions.If a formula is supplied, the result of the formula calculation is usedas the parameter value. These formulas are executed when the value ofthe parameter is requested. Formulas can consist of references to otherparameters in the current block, mathematical operations, etc.

Modifier Block Definitions are defined in a manner identical to that ofBlock Definitions. In Modifier Block Definitions, references to otherparameters in formulas are not restricted to existing parameters. SeePart 1 for a detailed description of modifier blocks. Parameter groupscan be defined to contain any or all parameters defined in the localdefinition or parent definitions. Parameter groups correspond to thetabs on the Block Property sheet display. The parameter group definitioncontains information on ordering for parameters contained in the group.All parameters are contained in at least one parameter group, but can beassigned to multiple groups. The user can select the group(s) to whicheach parameter belongs. Versioning of blocks is supported via standardversioning features supplied by the Framework classes. Each time a blockdefinition is changed, the block version is incremented. This data isused for reporting and tracking of block definition history. A securitymechanism is used to verify that the user has privileges to edit theselected block. No customer will have privileges to editimplementation-standard block definitions. These defined blocks can bederived from, but not changed. Reports can be generated on blockdefinitions, changes in the current edit session, and audit trails. Thereport for changes between versions is helpful internally to facilitateversion upgrades to customer systems.

2.2.2 Functions

The following functions are implemented by the Block Definition Editor:

-   -   Create new, derived or copied block definitions    -   Create new, derived or copied modifier block definitions    -   Add, remove, or modify parameters    -   Override parameters inherited from parent block definition,        revert to parent value    -   Group parameters into categories displayed on property sheet        during configuration    -   Provide a mechanism for ordering parameters on property sheet        page    -   View parameters as they would appear on property sheet    -   Define parameters to be control or non-control types    -   Define configuration-time formulas for parameter values,        recalculate values. These formulas will support math statements,        references to other parameters in blocks, etc.    -   Save/load definition(s) to/from diskette or file    -   Import definitions from pdef files or FoxCAE tables    -   Upgrade to new version of standard IAS block definitions    -   Maintain block version information    -   Report block/parameter definitions, changes, definitions in use,        block derivations    -   Provide audit trails for definition changes    -   Provide security which allows only certain people access to        block definitions    -   Provide security against changing implementation standard        control block definitions and standard parameter group        assignments.    -   Provide standard editing capabilities: cut, copy, paste, etc.    -   Provide search capabilities for parameters or content, allowing        the user to find parameters of a specified name or containing a        specified value

The following functions are provided in support of the Block DefinitionEditor:

-   -   Maintain standard set of control blocks    -   Version upgrade mechanism for redistribution of control blocks

2.2.3 Object Model 2.2.3.1 Block Definition

Referring to FIG. 70 Block definitions follow the basic paradigm definedfor Parameterized Objects. Block definitions contain lists of parameterdefinitions and overrides and maintain a pointer to their parentdefinition. Block definitions can be “base” definitions—those with noparent definitions, or “derived” definitions—those that inheritparameter definitions and overrides from a parent block definition.

The implementation includes a set of base definitions that correspond tocontrol algorithms in Control Processors, called control blocks. Userscan derive definitions from this set or create their own basedefinitions that do not correspond to Control algorithms, callednon-control blocks. Only block definitions derived from control blockswill be downloaded into a CP when instantiated in a running system.

Class Relationships:

-   -   Block definitions are parameterized objects.    -   Block definitions can create instances of blocks of their type        or block definitions derived from their type. The blocks or        block definitions created are also instances of parameterized        object-derived classes.    -   Block definitions contain parameter definitions. The parameter        set defines the type and characteristics of the block        definition, not the class of the block definition object. All        block definitions are of the class “Block Definition”, while the        type of the block definition varies according to the parameter        set. (AIN, PID, etc.)    -   Block definitions may contain parameter overrides. These        overrides modify the inherited parameter definitions.    -   Block definitions can refer to 0 or 1 parent block definitions.        The parent block definition defines a set of parameters that are        inherited and can be overridden.    -   Block definitions maintain an ordered list of Parameter Group        Definitions to use in creating a Property Sheet view for        modifying block parameter values. Each group corresponds to a        Separate Property Page within the Property Sheet. See Part 1 for        further discussion of Parameter Groups.    -   All block definitions are collected in Block Definition        Collections for use in reporting, viewing and listing block        definitions. These collections reside in the Project Manager        “System” hierarchy.

2.2.3.2 Block Parameter Definition

Block parameter definitions consist of a standard, framework defined setof attributes. The attributes of name and type compose the basicdefinition for a parameter. Other attributes such as default value,limits, description, etc. all contribute to the definition and can beoverridden in derived block definitions.

Block parameter definitions contain attributes which indicate whether itis a control or non-control parameter. Control parameters are thoserecognized by the control algorithms in Control Processors. Onlyimplementation standard blocks can contain control parameters.Non-control parameters can be used for calculation or documentationpurposes and do not get downloaded into a CP when they are part of acompound in a running system.

Some block types contain special parameters which cannot be viewed,edited or overridden by the user. Blocks like PLB and Sequence haveparameters which are not standard parameter types such as string, float,int, etc. but contain compiled ladder or sequence code.

Class Relationships:

-   -   Block parameter definitions are parameter definitions. They        provide all of the attributes of a parameter, such as name,        type, description, limits, etc.    -   Block definitions contain parameter definitions. The parameter        set defines the type and characteristics of the block        definition.    -   Parameter Groups collect block parameter definition for        displaying or reporting of parameters by Group identifier.

2.2.3.3 Block Parameter Override

Block parameter overrides can modify a value or attribute of aninherited parameter definition. When a new block definition is derivedfrom another block definition, any attribute modifications which aremade to inherited parameters are stored in the current block definitionas an override. Overrides are cumulative. Overrides which appear in aparent apply to derived block definitions as well.

Class Relationships:

-   -   Block parameter overrides are parameter overrides. They provide        the ability to override a most of the parameter attributes of        inherited parameter definitions. (Not included are parameter        name, type, etc.)    -   Block definitions contain parameter overrides. These overrides        modify the inherited parameter definitions.

2.2.3.4 Block Definition Container

A Block Definition Container provides a grouping mechanism for all blockdefinitions. Separate containers exist for block definitions, modifierblocks, and user work areas for block definitions. At systeminstallation time, the single block definition container for systemblock definitions is created. Users can create other containers forworking copies of block definitions.

A Block Definition Container provides a mechanism for iterating over allof the definitions it contains. This feature is inherited from thestandard Parameterized Object Container. Additional iteration methodsare supplied by this class to report on block definitions alphabeticallyor hierarchically. Block Definition Containers take many forms: nodes ofthe Project Manager “System” hierarchy which are used to hold BlockDefinitions, palettes of Block Definitions for use in the ControlAlgorithm Diagram Editor, and others. Class Relationships:

-   -   A Block Definition Container contains block definitions.    -   A Block Definition Container is a generic Parameterized Object        container restricting the Parameterized Object contents to Block        Definitions.

2.2.3.5 Modifier Block Definition

A Modifier Block Definition is a block definition. It can containparameters exactly like a standard block definition. Derived modifierblocks can override parameter attributes from parent modifier blocks. Amodifier block instance can be contained in a loop or composite blockjust like any other block, but does not behave in the same manner. Allparameters in a modifier block instance override parameters matching byname in the block to which it is attached. Modifier block definitions,however remain identical to block definitions. A Modifier Block cancontain formulas which reference parameters not necessarily defined inthe Modifier Block. Like Block Definitions, the calculations areexecuted whenever the value of the calculated parameter is requested.

2.2.3.6 Parameter Group Definition

A Parameter Group Definition maintains parameter grouping information toallow reporting or displaying parameters by selective groupings.Standard parameter groupings (such as Input/output, High/Low Alarms,Tuning) are provided for implementation standard block definitions.Users can add their own groupings but are not allowed to change thestandard groupings. Class Relationships:

-   -   A Parameter Group Definition is a Parameter Group, from which it        inherits the ability to maintain an ordered list of parameters.    -   A Parameter Group Definition maintains associations with        parameter definitions to define its group.

2.3 Control Algorithm Diagram Editor 2.3.1 Overview

The Control Algorithm Editor is the single editor for all ControlAlgorithm related work. With this editor, the user can graphicallycreate and edit Loop Templates, Simple Loops, Composite BlockDefinitions, Blocks and Connections. The user can also view and editsome properties of Composite Blocks and Template-Derived Loops.Composite Blocks and Template-Derived Loops are shown graphically basedon their definition or template.

FIG. 71 shows a single Simple Loop in the Control Algorithm Editor. Allcontrol algorithm diagrams graphical views look similar to this display,allowing new Blocks to be added by dragging and dropping from a paletteof available Blocks and positioning and connecting Blocks through mouseactions. The block or blocks which compose a loop or Composite Block aredisplayed in the center of the display. Modifier blocks which areapplied to individual are shown in the center with arrows indicatingwhich blocks they are modifying (ModType1). Modifier Blocks which applyto the entire Loop or Composite Block are shown attached to the drawingboundary (ModType2 and ModType2).

Loop Templates define the blocks, block parameters, internalconnections, and connections to external hardware points (Tags) for aloop. Any defined block or Composite Block type can be inserted into aLoop Template. When modifications are made to the Loop Template, theuser is prompted to download all of the derived loops. Changes made tothe Loop Template are automatically inherited by the derived Loops,since the Template is referenced whenever the derived Loops are accessedfor display or download.

The user defines any parameter values or connections for the loop andconnects the externally exposed block source and sink parameters to I/OBlocks. When instantiated, the placeholder I/O Block attributes (Name,type, enclosure, etc.) are assigned values. Tags are then assigned toconnections made within the I/O Block. The I/O Block Placeholders serveto group Tag List Row Placeholders associated with the same I/O device(FBM). When building loops, the user can add and remove I/O Block andTag List Row Placeholders from the drawing.

Template-Derived Loops are loops which are instantiated from LoopTemplates. Individual block parameters and connections to I/O hardwaredevices can be customized in each separate instantiation. Wheninstantiated, the user assigns the loop to a compound, assigns “real”block names, connects the I/O points to actual tags, and modifies valuesof parameters in the loop. This is either done manually or via the Loopgeneration function of the Tag List Editor. Any changes made toinformation specified in the Loop Template (Blocks included in the Loop,internal Block connections, etc.) result in the user being prompted toconvert the Loop to a Simple Loop, which will result in breaking thelink to the Loop Template. Parameters for Blocks in a Template-DerivedLoop can only be modified if they have been exposed as Loop parameters,as described below.

Simple Loops are loops which have no template. They are edited nearlyidentically to Loop Templates but can be created in the context of acompound and assigned to “real” blocks and I/O Blocks.

Composite Block Definitions define the blocks, block parameters,internal connections, and externally exposed connection points for aComposite Block, as shown in FIG. 72. When a Composite Block isinstantiated, it maintains an association with its defining CompositeBlock Definition. Individual block parameter values can then bemodified, or “overridden”, in the Composite Block instance. There is noconcept of a single-instance Composite Block, a Composite BlockDefinition is preferably used for every instance of a Composite Block.Like Simple Loops and Loop Templates, the user assigns block parametervalue overrides and connections within the Composite Block.

No external connections are created directly for Blocks contained withinComposite Block Definitions. Instead, the user defines which internalBlock parameters are exposed to users of the Composite Block.Internally, the user is creating a connection between a parametercreated for the Composite Block Definition and the internal Blockparameter that is to be exposed. These Composite Block Definitionparameters inherit their attributes from the parameters they areexposing.

Composite Blocks are instances of Composite Block Definitions. They canbe used like standard blocks in anything which can contain blocks.(Loops, Composite Blocks, etc.) Users cannot modify the defined valuesor connections within the Composite Blocks unless the parameters havebeen exposed by the Composite Block Definition. Users modify and connectto or from the exposed parameters of the Composite Block, similar toother Blocks. The exposed parameters can be edited on a loop sheet viathe parameter property sheet like the parameters of any standard Block.

FIG. 73 shows an instance of a Composite Block in a loop diagram. Someexposed parameters for internal blocks are shown like parameters for anystandard block. FIG. 74 shows the same loop diagram with the CompositeBlock expanded in-place to show its internal structure. While CompositeBlock internals can be viewed this way on a Loop drawing, they cannot beedited. Any attempt to add, delete, or manipulate the Blocks within theComposite Block outline results in the user being prompted to invoke theComposite Block Definition editor view.

All of the Control Algorithm Diagram objects can be stored in the user'sworkspace or the appropriate branch of the System tree. Simple Loops,Template-Derived Loops and Composite Blocks can be created in thecontext of a Compound.

Composite Blocks and Composite Block definitions define groups ofblocks, connections between them and specific values for the containedblock parameters. Simple Loops, Loop Templates and Template-DerivedLoops extend this to connect the blocks to external I/O points,represented by an I/O Block.

Blocks and Connections for standalone blocks in compounds can be madewith this editor. The user can edit parameter values and makeconnections to other standalone blocks graphically as shown in FIG. 75.Blocks containing parameters which supply inputs to the current blockappear in the left margin and blocks containing parameters receivingoutputs appear in the right margin. Only blocks not associated withLoops or Composite Blocks can be edited in this manner.

Each block on a control algorithm diagram is represented internally by aPlaceholder. This Placeholder holds information about the geometry,placement, and size of the visual block representation. The placement ofthe object is user-modifiable. The basic appearance, geometry and sizeinformation for an object is maintained in the user-definable Appearanceobject. The object's Placeholder maintains a reference to its Appearanceobject. From this representation of a block, the user can accessparameter and connection information or navigate to other loops,composite blocks or blocks by accessing the block's context menu.

The user can perform different functions on different parts of the BlockPlaceholder by right-clicking to bring up the context menu. Contextmenus contain unique functions depending on the object on which they areinvoked. For example, the user has the option to edit connections,parameters, block information, etc. The default double-click functionfor the Compound/block name section is to prompt for new Compound andBlock Names. The default function for the source/sink parameterssections is to bring up a connection dialog. In the Relevant blockparameters section, the default action is to select parameters displayedfrom a list of block parameters. The default action for the center of ablock is to bring up the block's Property Sheet.

Each Block Placeholder on the display has the same basic graphicalstructure. FIG. 76 shows a typical block on a graphical display. Thetype of the block is displayed in the center in a larger font than anyother in the block for easy viewing. The optional compound name andblock name appear at the top in a medium font. On Loop Templates,Composite Block Definitions or any block not downloaded, the compoundand block name fields are empty. Connected parameters appear in thesource/sink regions of the block. A small font is used for showingparameters. Sink parameters are shown on the left, source parameters onthe right. Parameter values that the creator of the diagram haveconsidered to be relevant to the drawing appear at the bottom. Whenparameters are added or removed from the lists of source, sink, ordisplay Parameters, the block is automatically resized.

Parameters are selected for display from a list presented in a dialog.Internally, these parameter selections are stored with the Placeholder,probably as part of the Appearance Definition. See Part 1 for a morecomplete discussion of Placeholders and related objects.

Composite Blocks have additional functionality which allows them to beexpanded in place on a control algorithm diagram. Composite Blocks canexpand to show the internal block representation in a trimmed-down viewof the actual Composite Block diagram. The expanded view is shownoutlined, to still denote the original Block, as shown in FIG. 74.

The Control Algorithm Diagram Editor has the ability to generate adefault graphical representation of a Template-Derived Loop or CompositeBlock. When loops are automatically generated via the Tag List Editor,for example, the Loop is created, but the graphical representation isnot. When the Loop is first printed or displayed, a defaultrepresentation is created.

All objects on the diagram are “active.” Each area of an object has acontext which is used for displaying popup menus. For example, thedefault action for the block type area is to show the property sheet forthe block. The default action for the relevant block parameters area isto bring up a list of parameters available to be displayed there.Clicking and dragging from within one of the sink or source areas toanother blocks source or sink generates a new connection. If theparameters to be connected are exposed on the Block Placeholders, theconnection can be made directly. If the parameters to be connected arenot shown on the Placeholders, the user can invoke a connection dialog.

Using the dialog presented in FIG. 77, users can connect Blockparameters in Simple Loops and Template-Derived Loops to parameters inother Blocks in the loop, parameters in blocks outside of the loop, I/Opoints from a Tag List, or “expose” the parameter as a tuning parameterof the loop. When the user is making connections within a Loop Templateor Composite Block Definition, the connection definition portion of theConnection Dialog looks like FIG. 78. Users can only make internalconnections or expose parameters as tuning parameters for templates anddefinitions. FIG. 79 shows the connection definition portion of thedialog when the user has decided to expose a parameter as a tuningparameter or for external connection for a Composite Block.

Connections between blocks and their respective source and sinkparameters are indicated with arrows from source to sink parameter.External connections are displayed in the margins—inputs to the Loop,Block, or Composite Block are to the left and outputs are to the right.Connections to and from these blocks and placeholders are indicated inthe same manner as internal connections. Connections to Blocks outsidethe loop or “exposed” parameters in Composite Blocks and Loop Templatesare shown as Connections that come out of a Block Placeholder andterminate at a label a short distance from the point of origin. Thislabel then appears in a table at the lower corner of the screen. Inputsare in a table in the lower left, outputs in the lower right. Thesetables contain the label and the actual C:B.P to which the point isconnected.

Users have full control over placement of blocks in the center regionand ordering of connections in the source and sink parameter lists.Connection lines are automatically drawn. Blocks in the input and outputmargins can be reordered or moved between margins. Blocks, Loops, andComposite Blocks can be assigned to Compounds and downloaded via mainmenu or context menu picks on the individual blocks. Users may select“Edit Parameters . . . ” from the context menu of any block. This bringsup the property sheet for the block as shown in FIG. 70. From theParameter Property Sheet, the user can modify values for the Parametersof the selected Block. For Composite Blocks and Template-derived Loops,the user is presented with a dialog like that in FIG. 81. From thisdialog, the user can set values for the “exposed” parameters of anycontained block. Refer to Part 1 for a more complete description ofProperty sheets. The pull-down list box shown on the Composite BlockProperty sheet is a shortcut to navigate to all the internal Blockparameters which are exposed. An alternative to this approach is togroup all the exposed parameters onto separate Property sheet pages,grouped by Block. The pull-down menu is also useful to incorporate inthe Property sheet for Simple Loops, as a shortcut to access Blockparameters without having to navigate the Loop drawing.

In addition to entering constant values, the user can enter formulas forBlock Parameters to be calculated based on other Parameters, Tags,Connections, etc. as shown in FIG. 82. Refer to the discussion of thisdocument on Smart Blocks for a more detailed description of theseformulas.

2.3.2 Functions

The following sections describe functions that are implemented by theControl Algorithm Diagram Editor. Most graphical functions apply to allof the visual block/connection type objects which can be configured.Functions specific to the object being edited are in their respectivesections.

2.3.2.1 General graphical Control Algorithm Diagram Editor functions

-   -   Graphical functions        -   Graphically create, view, and edit Composite Block            Definitions, Composite Blocks, Loop Templates,            Template-Derived Loops, Simple Loops        -   Display status information (Editing template, editing loop X            in C:B.P, online, offline, etc.)        -   Undo/redo data or graphical changes, revert to previous            version        -   Provide standard diagramming and document functions like            object alignment, snap to grid, cut, copy, paste, zoom,            multiple selection        -   Allow user placement of blocks on sheet        -   Specify restrictions on instantiation of Loop Template or            Composite Block Definition: blocks are preferably in the            same compound, fixed block ordering, etc.        -   Navigate to other block display by selecting referenced            block in current display        -   View and edit CALC Block calculations, PLB Block ladder            logic, Sequence Block logic, and Logic Block logic.        -   Create a Loop which spans multiple Loop Sheets        -   Display Composite Block details on diagram.        -   Invoke Block Property Sheets from Loop drawing        -   Invoke Property Sheet for Block Collection objects (Loop,            Loop Template, Composite Block Definition) from drawing            sheet        -   Display live values for parameters in blocks on current            drawing. This can only be done when viewing checked-in            copies of drawings, not on user workspace copies.    -   Database functions        -   Create and edit Composite Block Definitions, Composite            Blocks, Loop Templates, Template-Derived Loops, Simple Loops        -   Create instances of Blocks and Composite Blocks on a control            algorithm diagram        -   Connect parameters between blocks on diagram        -   Move connections        -   Generate Display file for loop or composite block        -   Define parameters to display in block display, source and            sink regions        -   Enter diagram title, description, info, local block names        -   Define general formulas used for all blocks in diagram        -   Attach Modifier blocks to blocks in diagram or entire object        -   Add, delete blocks to sheet        -   Edit block parameters via property sheets        -   Copy blocks from one instance of editor to another or within            single editor via drag-drop.        -   Create new loops, composite block definitions, loop            templates from groups of selected blocks        -   Maintain version history and audit trail of templates,            definitions, instances        -   Security based on default and administrator-configurable            read, write, download, etc. permissions, as provided by            Framework security functions        -   Allow only authorized developers to modify implementation            standard Block Definitions and Loop Templates        -   Assign Blocks in Loops to different Compounds or all Blocks            in Loops to a single Compounds        -   Define block processing order for blocks in a loop. This            value is a suggested order which can be overridden by            actions in the Compound Editor.        -   Determine Block names at Loop instantiation time based on            name macros, loop macros, and Modifier Blocks applied        -   Download Blocks/Loops to CP        -   Provide “Save As” functionality—Composite Block can be saved            as Loop, vice-versa        -   Ensure valid connections between blocks        -   Assign Blocks to Compounds either individually or by Loop        -   Provide back documentation capability in support of            Import/Export Manager. This includes the ability to generate            a default drawing layout for Loops and Loop Typical            (templates) imported from FoxCAE.        -   Provide bulk Loop generation capability in support of Tag            List Editor capability to generate Loops from the Tag List.        -   Import and export Blocks, Block Definitions, Composite Block            Definitions, Loops, Loop Templates, Template-Derived Loops            to/from diskette using IDA format    -   Other general functions        -   Print sheet        -   Optionally show/print Sequence, CALC, and PLB Block Logic on            secondary sheets        -   Report on definitions, instances, connections, instances of            specified definition or template    -   Interact with other editors:        -   Invoke Block Definition Editor            -   Modify/create Block Definitions        -   Invoke Historian Collection Point Editor            -   Assign Parameters, Blocks, or Loops to Historian                Collection Group        -   Invoke Import/Export Manager            -   Import and export Blocks, Block Definitions, Loops, Loop                Templates to/from external packages        -   Invoke Compound Editor            -   Assign blocks to compounds            -   Assign block ordering within compounds        -   Invoke Download/Upload Manager            -   Download Loop/Blocks to CP            -   Upload current parameter values        -   Invoke Enclosure Editor            -   Assign Tags to FBM Modules        -   Invoke Tag List Editor            -   Assign tags to loops            -   Generate loops from tags    -   Automation Interface functions        -   Create/delete Blocks, Template-Derived Loops        -   Upload/download Blocks, Loops        -   Set/get parameter values        -   Get lists of available Blocks, Compounds, Loop Templates,            etc.

2.3.2.2 Loop Template Unique Functions

-   -   Create Loop Template exposed parameters, connect internal Block        parameters to exposed parameters    -   Connect parameters to I/O Block    -   Show blocks which are targets for external point connections on        sheet, different from blocks contained in template    -   Create “soft connections—Connections which are created based on        Tag List information        -   Example: Connect to shared MAIN block parameter based on            correlation with tag associated with MAIN inputs from I/O    -   Edit Loop Template which has instances        -   Mark all derived instances of Template-Derived Loops as            “needs to be downloaded”        -   Prompt to download all affected Template-Derived Loops        -   Provide information on what blocks/compounds may be affected

2.3.2.3 Template-Derived Loop Unique Functions

-   -   Connect parameters to I/O Block parameters    -   Generate Template-Derived Loops from Loop Templates    -   Assign I/O Block placeholders to Tags    -   Override internal block parameter values on database upload,        including parameters which are not exposed    -   Disconnect from Loop Template—convert to Simple Loop

2.3.2.4 Composite Block Definition Unique Functions

-   -   Create Composite Block exposed parameters, connect internal        block parameters to exposed parameters    -   Prohibit external parameter connections, all connections are        preferably through exposed parameters

2.3.2.5 Composite Block Unique Functions

-   -   Override internal block parameter values on database upload,        including parameters which are not exposed    -   Create instance of Composite Block in Simple Loop/Loop        Template/Composite Block Definition, connect exposed points    -   Show as single block or expanded block detail on sheet,        including block structure and internal connections

2.3.2.6 Simple Loop Unique Functions

-   -   Connect parameters to I/O Block parameters

2.3.3 Object Model

The following sections describe the object model used by the ControlAlgorithm Diagram Editor. FIG. 83 shows the basic control objects andthe Framework objects from which they are derived. These objects areshown in greater detail in later figures. Note that the I/O Blockdescribed in these sections is actually a Tag List Row, as described inthe Tag List Editor section of this document.

Modifier Block Definitions, Composite Block Definitions, and LoopTemplates are unique definitions in that unlike Block Definitions, otherdefinitions cannot be derived from these objects. If a user wants tocreate a variant of these definitions, this can be done by copying thedefinition and then modifying the copy.

2.3.3.1 Block

Referring to FIG. 84 Block is the foundation for all control on the IASsystem. All of the control structures defined in this editor are basedon Blocks and collections of Blocks. A Block is a container forParameters. Each of these parameters has a type (float, string, integer,etc.) and attributes (connectable, high range, low range, length, etc.)which define the range of values it can contain. These parameters canalso be connected to parameters in the same block or any other block inthe system via the Source Endpoint and Sink Endpoint lists. EachEndpoint object represents a parameter in the current block. A singleparameter can be the source for many other parameters, but may only be asink of one parameter. Therefore, only one Sink Endpoint may exist foreach parameter while many Source Endpoints can exist for each parameter.Blocks must preferably have a definition. A Block Definition defines theset of parameters names, types, attributes and values for a block. Theset of parameters defines the block type. See Part 1 for a detaileddescription of Parameters, Parameter Definitions, and ParameterOverrides. The Block Definition can be a simple Block Definition, aderived Block Definition or a Block Instance. In any case, the Blockcontains a list of Parameter Overrides which override the default valuesin the definitions.

Blocks contain a list of Modifier Blocks which are applied to them.Modifier Blocks contain a list of parameter values. For any parametervalues in the Modifier Block which have matching names, the values inthe Modifier Block override the values in the Block.

When a Block's parameter values are needed, they are determined by thefollowing algorithm. For each parameter defined in any parent BlockDefinition, all Modifier Blocks are searched for matching parameternames. If there is a match, the value is used. Otherwise, the heritagetree is searched for any overrides or default values. The exact logic isencapsulated into Parameters, described in the Part 1. If the root BlockDefinition for this Block is defined as an implementation standardControl Block, the control parameter values then can get installed to aIAS control station.

Blocks can be contained in Compounds, Loop Templates, Simple Loops, andComposite Block Definitions. Blocks are not actually contained, butlogically contained in Composite Blocks and Template-Derived Loops byway of their parent definitions or templates. Blocks which are inTemplate-Derived Loops, Simple Loops, Composite Blocks, or single Blockscan be assigned to a Compound in an IAS system. When Blocks areinstalled, they are then contained by both the loop or composite blockto which they belong and the Compound to which they are assigned.

Blocks contain lists of Source Endpoints, Sink Endpoints, ParameterOverrides, and Modifier Blocks. All of these lists and their handlingare inherited from Parameterized Object. The list of Modifier Blocksinherited is a Parameterized Object list, Block enforces that onlyModifier Blocks are placed in that list. Blocks are capable ofinteracting with the IAS via its application programming interface(FoxAPI) and the DB Installer. When a block is told to download orupload to/from a CP, it establishes a connection to the CP and performsthe requested function. When viewing live data on a loop diagram in thefuture, the Block will be capable of creating an list via FoxAPI andretrieving live values for displayed parameters and connections.

Both Block and Block Definition are derived from Parameterized Object totake advantage of the services provided by that class. Block and BlockDefinition are separate classes because they perform different roles inthe Control Algorithm Diagram object model. Block Definitions are staticobjects, which cannot be downloaded, can contain definitions ofParameters and Overrides, and can only reside in the Block Definitionportion of the database. Blocks can be downloaded, can only containOverrides, and reside in the Project portion of the database.

Class Relationships:

-   -   The Block object maintains a reference to its Block Definition.        This definition could also be another Block instance, which in        turn, refers back to its Block Definition.    -   Block is derived from Parameterized Object. It inherits its        ability to maintain a list of parameters, be contained in a        Parameterized Object Collection, maintain endpoints to        connections, and keep a list of Modifier Blocks from this parent        class.    -   Block maintains a list of Parameter Overrides. These values        override the values or default values of parent Block or Block        Definition.    -   Block maintains a list of Source Endpoints and Sink Endpoints        for connections made between Parameterized Objects.    -   Block can contain references to one or more Modifier Blocks.        Modifier Block parameters act as overrides to the current Block.    -   Blocks can be contained in Compounds, Loop Templates, Simple        Loops and Composite Block Definitions. They are also logically        contained in Composite Blocks and Template-Derived Loops via        reference to their respective definitions or templates. Blocks        maintain associations with their containers for use in “where        used” reporting, supported as part of the Framework.

2.3.3.2 Modifier Block

Referring to FIG. 85 A Modifier Block is an object that modifies allmatching parameters in an associated Block or block collection object.Whenever an object needs to reply to a request for parameter values, anyassociated Modifier Block parameter values override Block values andBlock Definition default values. Handling of the Parameter Values ismanaged by the inherited Block class. No Source Endpoints or SinkEndpoints are used by Modifier Block. Connections cannot be made toparameters in a Modifier Block.

Like any Block, Modifier Blocks have definitions which give eachModifier Block its type. Modifier Block maintains a reference to itsparent definition. This mechanism is identical to that of the Blockobject. Modifier Blocks can be attached to all types of block collectionobjects, but do not appear in Compounds. They contain parameters but donot get downloaded like other Block types. The Modifier Block parametersapply to the matching parameters of all Blocks or block collectionswhich contain it. Modifier Blocks do not apply Parameter Overrides toBlocks within Composite Blocks or Template-Derived Loops. Parameters arepreferably be exposed for Modifier Blocks to affect Parameters in Blocksinside the Composite Block or Loop. Parameter values for a block aredetermined by looking at related objects in the following order:

-   -   1. Block Definition Hierarchy    -   2. Global Modifier Block (attached to entire Loop)    -   3. Local Modifier Block (attached to specific Block)    -   4. Local Block

Any values found along this path become the value for the Parameter. Forexample, if a Global Modifier Block contains MEAS=5 and a Block on theLoop has a value of MEAS explicitly set to 4, then MEAS=4 for that Blockbecause the Local Block value overrides all other values.

FIG. 86 presents a Simple Loop containing a Composite Block with severalModifier Blocks. Three scenarios are presented for the configuration.

-   -   Scenario 1: In this scenario, no parameters of Composite Block A        are exposed. Therefore, Modifier Blocks in Loop1 can have no        effect on Block E and Block F. Modifier Block H applies to both        Block E and Block F, but Modifier Block G overrides this value.    -   Scenario 2: In this scenario, the MEAS parameter of Block F is        exposed in Composite Block A. This allows the Modifier Blocks in        Loop1 to adjust the Parameter value. Again, the local Modifier        Block (Modifier Block D) affects the value of MEAS.    -   Scenario 3: In this scenario, the MEAS parameter of Block E is        exposed in Composite Block A. The MEAS parameter of Block E now        takes on the value of the local Modifier Block in Loop1.

Class Relationships:

-   -   Modifier Block is derived from Block. From Block it inherits the        ability to be contained in a block collection and its ability to        manager Parameter Overrides.    -   Multiple Modifier Blocks can be contained by Composite Block        Definition-derived object or Block-derived objects.    -   Modifier Block maintains a reference to its definition, if any,        which can be an instance of a Modifier Block.

2.3.3.3 Composite Block Definition

Referring to FIG. 87 Composite Block Definition is a ParameterizedObject Collection derivative. Composite Block Definition provides thecommon functionality for all objects that contain collections of Blockobjects: Composite Block Definitions, Loop Templates, and Simple Loops.It is an extension of the Parameterized Object Collection class whichrestricts the Parameterized Objects it contains to objects derived fromthe Block class.

Composite Block Definition inherits from Parameterized Object Collectionthe ability to manage Parameterized Objects, (in this case, Blocks) itsown parameters, (a Parameterized Object Collection is a ParameterizedObject) attached Modifier Blocks, and its Connection Endpoints. Like theBlock class, Composite Block Definition is responsible for ensuring thatonly Modifier Blocks are stored in the Modifier Block list. FromParameterized Object Collection it inherits the abilities to maintainlists of Connection Endpoints, Parameters, Modifier Blocks, and Blocks.To Parameterized Object Collection it adds special handling of the listsof Parameters and Connection Endpoints inherited from parent classes.Composite Block Definition defines Composite Blocks to be instantiatedin other Composite Block Definition-derived Collections.

The Parameters that are owned by this class represent the “exposed”parameters of the Composite Block. These Parameters are linked to theparameters in the contained Blocks that they “expose” through theConnections maintained by this class. These parameters are the onlyparameters that any container of the instantiated Composite Block canaccess. The initial values for the attributes of the parameters arecopied from the parameters they expose. These attributes can then bemodified.

Composite Block Definition is not responsible for maintaining anyConnections outside of this object. All Connections maintained in thisobject refer to “exposed” parameters. Connections can be made ininstances of Composite Blocks from parameters defined here to otherBlocks. With the “exposed” parameters defined and their values connectedto internal parameters, the Composite Block defined looks like a Blockto other Composite Block Definition-derived classes. The instantiatedComposite Block derived from this definition can be used like any otherblock in Composite Block Definition-derived Classes.

Modifier Blocks contained by Composite Block Definition apply to allblocks contained by the object. Composite Block Definition isresponsible for adding Modifier Block references to all of its containedBlocks when a Modifier Block is attached to it. This allows theParameter Facade classes defined by the Framework to access ModifierBlock parameters.

Composite Block Definitions can create instances of the Composite Blocksthey define. These instances maintain a pointer to this class as theirdefinition. These instances maintain overrides of the “exposed”parameters and of parameter value changes made via an Upload operationto retrieve current parameter values from the Control Processor.Composite Block Definitions supply their instances with the actual blocknames of “exposed” parameters on request. This is useful when displayingthe value of a connected point or when the value must actually be placedin a running control system. Class Relationships:

-   -   Composite Block Definition is a Parameterized Object Collection.        From Parameterized Object Collection it inherits the ability to        manage parameters, connections, and Blocks.    -   Composite Block Definition maintains a reference to a parent        definition, if any. Many Composite Block Definitions can be        derived from a single definition.    -   Composite Block Definition can contain any number of Composite        Blocks and Blocks.    -   Modifier Blocks can be attached to Composite Block Definitions.        When they are attached, the parameter value overrides of the        Modifier Block apply to all blocks in the Composite Block        Definition.    -   A Composite Block Definition cannot contain a I/O Block    -   Composite Block Definition maintains a list of Source Endpoints        and Sink Endpoints. These are used to connect “exposed”        Parameters to their actual points within the Composite Block        Definition.    -   Parameters are used to store the “exposed” parameter definitions        for the defined Composite Block.    -   The Composite Block Definition class can create Composite Blocks        derived from itself. This ability is inherited from        Parameterized Object Collection.

2.3.3.4 Loop Template

Referring to FIG. 88, Loop Template is a Composite Block Definitionderivative. It defines the Blocks and Connections contained in a controlloop. From Composite Block Definition and its ancestors it inherits theabilities to maintain lists of Connection Endpoints, Parameters,Modifier Blocks, and Blocks. It also inherits the ability to “expose”parameters of blocks in the loop from the Composite Block Definitionclass. These parameters are then available as tuning parameters or toconnect to other Loops or Blocks. To Composite Block Definition it addsthe ability to add I/O Blocks. The I/O Blocks added to a Loop Templatedo not represent real tag points, but are placeholders for actual Tagsin the derived Template-Derived Loop instances.

The Parameters that are owned by this class represent the “exposed”parameters of the Loop. These Parameters are linked to the parameters inthe contained Blocks that they “expose” through the Connectionsmaintained by this class. These parameters are the only parameters thatare available for tuning or external connections. The initial values forthe attributes of the parameters are copied from the parameters theyexpose. These attributes can then be modified.

Loop Template is not responsible for maintaining any Connections outsideof this object. All Connections maintained in this object refer to“exposed” parameters. Connections can be made in instances ofTemplate-Derived Loops from parameters defined here to other Loops. Withthe “exposed” parameters defined and their values connected to internalparameters, the Template-Derived Loop defined looks like a Block toother Composite Block Definition-derived classes. This allowsconnections to be made into the Loop look like Composite Blockconnections. Modifier Blocks contained by Loop Template apply to allblocks contained by the object. Loop Template is responsible for addingModifier Block references to all of its contained Blocks when a ModifierBlock is attached to it. This allows the Parameter classes defined bythe Framework to access Modifier Block parameters.

Like Composite Block Definitions, Loop Templates can create instances ofthe Template-Derived Loops they define. These instances maintain apointer to this class as their definition. These instances can maintainoverrides of the “exposed” parameters only. Instances which are createdfrom this definition in the context of a definition library are allowedto override parameter attributes and values for “exposed” parameters.Instances created from this definition in a usage context as astand-alone Template-Derived Loop can only override values. ClassRelationships:

-   -   Loop Template is a Composite Block Definition. From Composite        Block Definition it inherits the ability to manage parameters,        connections, and Blocks.    -   Loop Template maintains a reference to a parent definition, if        any. Many Loop Templates can be derived from a single        definition.    -   Loop Template can contain any number of Composite Blocks and        Blocks.    -   Modifier Blocks can be attached to Loop Templates. When they are        attached, the parameter value overrides of the Modifier Block        apply to all blocks in the Loop Template.    -   Loop Template contains Source Endpoints and Sink Endpoints.        These are used to connect “exposed” parameters to their actual        points within the Loop Template.    -   Parameters are used to store the “exposed” parameter definitions        for the defined Loop. These are the parameters tunable in Loop        instances.

2.3.3.5 Simple Loop

Referring to FIG. 89, Simple Loop is derived from Loop Template. FromLoop Template and its parent classes, Composite Block Definition andParameterized Object Collection it inherits all of the collection andconnection functionality of Loop Templates. Simple Loop adds to LoopTemplate the ability to connect to actual I/O Blocks and to install itsBlocks into an online Compound. Class Relationships:

-   -   Simple Loop is derived from Loop Template. It performs all of        the same functions as a Loop Template with the additional        capabilities of referencing real I/O Blocks and installing its        contained Blocks to a Compound.    -   Simple Loop can contain any number of Composite Blocks and        Blocks.    -   Modifier Blocks can be attached to Simple Loops. When they are        attached, the parameter value overrides of the Modifier Block        apply to all blocks in the Simple Loop.    -   Loops can optionally be “assigned” to a Compound. This is a        virtual assignment, since Compounds do not have any notion of        what a Loop is and the Blocks in a Loop can be downloaded to        different Compounds. This association is used as the default for        assigning Blocks in a Loop to a Compound. When a Loop is        assigned to a Compound, all unassigned Blocks within the Loop        are assigned to the Compound, and all Blocks added to the Loop        in the future are automatically assigned to the Compound. Blocks        can be reassigned by selecting the Block and choosing the        “Assign to Compound” menu selection.    -   Parameters are used for user-customized purposes, such as value        propagation to Block parameters within the Loop, or grouping        commonly accesses Block Parameters onto the Loop Property sheet.

2.3.3.6 Composite Block

Referring to FIG. 90, A Composite Block is a Block. It can be insertedinto any block collection as if it were a Block. It maintains a list ofparameter overrides which, if present, override the default values andattributes of the Composite Block Definition “exposed” parameters, justlike a Block. Connections can be made to parameters in the CompositeBlock, just like a Block.

A Composite Block uses the Parameter list inherited from ParameterizedObject to maintain a mapping of internal block parameters to exposedparameters. A Composite Block instance simply overrides the values ofthe “exposed” parameters. It cannot add Blocks or Connections to theComposite Block definition. In the context of an upload of parametersfrom a running station, overrides can be attached to this object whichoverride parameters in blocks contained in the Composite BlockDefinition. These overrides refer to the parameter in a hierarchicalmanner, using local block names. If a Composite Block Definitioncontains Blocks A and B, the Composite Block can override the value ofthe contained Block B by creating an override of “B.parm”. This behavioris supported by the Framework. Class Relationships:

-   -   Composite Block inherits from Block the ability to act like a        block in Loops, other Composite Blocks, etc. as well as        parameter and connection management.    -   Composite Blocks can be contained in Loop Templates, Simple        Loops, and Composite Block Definitions. In each instance,        Composite Block looks just like a Block to the container.    -   Modifier Blocks can be attached to Composite Blocks. When they        are attached, the parameter value overrides of the Modifier        Block apply to all blocks in the Composite Block.    -   Composite Blocks contain Parameter Overrides, Source Endpoints,        and Sink Endpoints just like Blocks. Their usage is identical.

2.3.3.7 Template-Derived Loop

Referring to FIG. 91, Template-Derived Loop inherits all ParameterOverride, external Connection handling, instantiation/definitionrelationship, and contained-Block name mapping functionality fromComposite Block. Template-Derived Loops have the additionalresponsibility that they preferably manage the mapping of I/O Blocks toactual parameters. I/O Blocks contain the name of the point theyrepresent, so mapping is preferably done from that point to a containedBlock parameter, via the same mechanism outlined in the Composite Blockdescription. Template-Derived Loops add the restriction that they cannotbe contained in block collections. See the description of the Blockclass for how this is accomplished. Class Relationships:

-   -   Template-Derived Loop is a Parameterized Object. From        Parameterized Object it inherits the ability to manage        parameters and connections. Compounds maintain a reference to        Template-Derived Loops.    -   Template-Derived Loop maintains a reference to a parent        definition. Many Loop Templates can be derived from a single        definition.    -   Modifier Blocks can be attached to Template-Derived Loops. When        they are attached, the parameter value overrides of the Modifier        Block apply to all exposed Block parameters in the        Template-Derived Loops.    -   Template-Derived Loop contains Source Endpoints and Sink        Endpoints. These are used to connect “exposed” parameters to        other Loops.    -   Parameters are used to store the “exposed” parameter definitions        for the defined Loop. These are the parameters tunable in Loop        instances.

2.3.3.8 Block Placeholder

Block Placeholder is the base Placeholder class for all Block objects.It is derived from Parameterized object Placeholder. FIG. 92 shows anexample of a graphical Block representation. Block Placeholder maintainsthe graphical representation of the rectangular dimensions of the block,the location for the associated Compound and Block names, the locationfor the Block type, the location and list of parameters displayed in the“relevant block parameters” section, and the location, order and list ofparameters displayed in the source and sink sections.

The model shown in FIG. 92 shows the I/O Block Placeholder collectingthe Tag List Row Placeholders that are associated with its related FBMModule. Alternate embodiments can allow for connecting Tag List RowBlocks to other Blocks (AIN, AOUT, etc.) before it is known which FBMswill be used. This requires the ability to integrate a number ofexisting Tag List Row Placeholders into a common I/O Block Placeholderrather than starting with the I/O Block Placeholder and adding Tag ListRows. Class Relationships:

-   -   Block Placeholder is the base class for all blocks placed on any        control algorithm diagram.    -   Block Placeholder is derived from Parameterized Object        Placeholder, from which it derives the ability to retrieve        information from its associated Parameterized Object.    -   Block Placeholder maintains a reference to the Block it        represents. Many placeholders can exist for any given Block.        Each Block maintains references to its Placeholders.

2.3.3.9 Modifier Block Placeholder

This class inherits all functionality from Block Placeholder, excepthandling of source and sink parameters. Parameters in a Modifier Blockare not connectable. Class Relationships:

-   -   Modifier Block Placeholder is derived from Block Placeholder.    -   Modifier Block Placeholder maintains a reference to the Modifier        Block it represents. Many Modifier Block Placeholders can exist        for any given Modifier Block.

2.3.3.10 Composite Block Placeholder

All functionality is inherited from Block Placeholder with no additions.Class Relationships:

-   -   Composite Block Placeholder is derived from Block Placeholder.    -   Composite Block Placeholder maintains a reference to the        Composite Block it represents. Many Composite Block Placeholders        can exist for any given Composite Block.

2.3.3.11 I/O Block Placeholder

This class inherits all functionality from Block Placeholder includingthe ability to manage Tag List Row Placeholders. Class Relationships:

-   -   I/O Block Placeholder is derived from Block Placeholder.    -   I/O Block Placeholder maintains a reference to the FBM it        represents. Many I/O Block Placeholders can exist for any given        FBM.    -   I/O Block Placeholder maintains references to Tag List Row        Placeholders. These represent the I/O points for the FBM.

2.3.3.12 Tag List Row Placeholder

This class inherits all functionality from Block Placeholder with noadditions. Class Relationships:

-   -   Tag List Row Placeholder is derived from Block Placeholder.    -   Tag List Row Placeholder maintains a reference to the I/O Block        Placeholder which contains it.    -   Tag List Row Placeholder maintains a reference to the Tag List        Row it represents. Many Tag List Row Placeholders can exist for        a single Tag List Row (for example, when using a common hardware        contact for multiple CIN Blocks).

2.3.3.13 Control Algorithm Diagram Document

Control Algorithm Diagram Document is the basic Persistent Documentclass (see FIG. 93) for all graphical drawings of block collections. Itderives its persistence and management of Placeholders from thePersistent Document Framework class. This class is responsible formaintaining all information necessary to graphically reproduce a ControlAlgorithm Diagram Document. Control Algorithm Diagram Document maintainsinformation about the overall view of the block collection itrepresents. This information includes title, subtitle, and scale.Information about each individual object is stored in its respectiveplaceholder. This information includes location, size, color, font, orany attribute which can be specified about an individual ControlAlgorithm Diagram object. Control Algorithm Diagram Document supplieslists of placeholders to the Control Algorithm Diagram Editor. Theplaceholders are then queried for specific drawing information.

This class is used as the persistent drawing class for Composite BlockDefinition drawings and Composite Block drawings.

The object model, as described above, provides Template-derived Loopsand Composite Blocks with their own Control Algorithm Diagram Documentobjects. This allows more flexibility for adding Modifier Blocks and forrepositioning Blocks defined in the definition objects. An alternativeapproach to consider during detailed design is to have Template-derivedLoops and Composite Blocks use the document objects associated with theLoop Templates and Composite Block Definitions, instead of having theirown documents. Class Relationships:

-   -   Control Algorithm Diagram Document derives from Persistent        Document, from which it inherits persistence and handling of        Placeholders.    -   All Control Algorithm Diagram drawings are derived from this        class.    -   Control Algorithm Diagram Document contains Block Placeholders,        Connection Placeholders, and Point Placeholders. These supply        the base functionality for Block and Loop Documents.

2.3.3.14 Loop Document

Loop Document derives all Control Algorithm Diagram functionality fromits parent class, Control Algorithm Diagram Document. This class addsmanagement of two margin areas reserved for I/O Blocks. The ordered listof I/O Block Placeholders is maintained for both input and outputmargins. I/O Block placement within the margin is maintained by the I/OBlock Placeholder. This class is used as the persistent drawing classfor Loop Template drawings, Template-Derived Loop Documents, and SimpleLoop Documents. Class Relationships:

-   -   Loop Document is a Control Algorithm Diagram Document, from        which it inherits all of the standard block placement, movement        and connection functions. Loop Document adds additional special        handling for I/O Blocks.    -   All Loop Documents are derived from this class.

2.4 PLB Ladder Diagram Editor 2.4.1 Overview

The Programmable Logic Block (PLB) supports a ladder logic diagramprogram executing in a digital Field Bus Module. See FIG. 94. The PLBspecifies the source for the Ladder Logic Diagram. The block ispreferably created before the ladder diagram can be built. The block'sparameters are configured through the Control Algorithm Diagram editor.

2.4.2 Ladder Diagram Editor Detailed Functionality 2.4.2.1 LadderDiagram Editing Functions

Referring to FIG. 95 The PLB (Programmable Logic Block) Editor allowsthe user to graphically configure PLBs in a manner similar to theexisting PLB Editor. The Ladder Diagram Editor consists of a graphicalladder editing window that works in conjunction with a palette/libraryused to store and retrieve sample source and a compiler output windowused to list and locate ladder errors.

The ladder elements are selected from the palette view and placed onto agraphical representation of the ladder logic. The currently selected PLBelement is highlighted. The user may alternately insert elements throughkeystrokes. Arrow keys may also be used to select different PLB elementsin the view. The IDA main frame window provides menu items for the PLBeditor. The PLB editor supports the following menu items:

Menu Item Name Description File Close Close PLB editor Compile CompilesPLB ladder Import Prompts for a .p file to import Download Generatesdefault displays then calls interface to download compiled ladder to FBMPage Setup . . . Allows printed page setup Print Preview . . . Allowspreview of printed ladder Print Prints ladder Edit Undo Undo lastgraphical edit of ladder Redo Redo what ‘Undo’ has done Cut Cutsselected element from ladder diagram to clipboard. Copy Copies selectedelement to clipboard. Paste Pastes element from clipboard to currentlyselected location in ladder diagram Delete Deletes currently selectedelement from ladder. Select All Selects all elements in the ladder. FindFinds a tag identifier or goes to a line number in a ladder HelpContents and Index . . . Presents help documentation on the PLB EditorWhat's This . . . Allows use of mouse cursor to select elements in PLBeditor and bring up online help on the element.

All configured ladders are stored as parameters for their associated PLBin the IDA database. This is a many-to-one relationship. Many PLBs maybe associated with one Ladder.

Ladders contain one or more rungs, with each rung consisting of one ormore lines and rung descriptors. The lines in a rung can be eitherprimary or secondary lines. To create a rung, the user selects a rungelement from the palette or uses a predefined function key. The firstline in a rung is the one and only primary line and all other lines aresecondary lines. The primary line is the only line in a rung, which isconnected from input power rail to the output power rail. Allconnections between lines are preferably made between the primary lineand a secondary line. A user is able to enter optional descriptors forthe rung. Each rung has an area associated with it that allows the userto enter separate comments for the operator and engineer. The commentsare displayed after the last line of the rung with the operator commentabove the engineer comment. The operator comment can be 3 lines of texteach 60 characters in length.

Lines consist of up to eight symbols. The first seven symbols in a linecan only be input symbols. The eighth (last) symbol in a line ispreferably an output symbol. The primary line in a rung has an inputsymbol in the first slot and an output symbol in the last slot.

Symbols are entered into a rung via a palette selection or function key.They are entered through the palette by drag and drop. To enter a symbolvia function key, the user selects an entry selection (1 of 8) in aladder rung and enters a predefined function key.

Symbols have a logic type, a Tech ID, and Tech ID description and areshown for each symbol on the Ladder Editor view. Preset and reset countsare also shown for counter and timer symbols. The user assigns a Tech IDfor a symbol from a list of valid Tech IDs through a context menu. Theuser can assign an optional description to each Tech ID via a menu pickwhich presents a list of Tech IDs and associated description fieldswhich the user can edit.

Connections between symbols are made automatically for symbols placed inadjacent slots on a line. Connections between symbols on different linesare made by dragging and dropping symbol endpoints. Logic for validconnections is maintained by the editor application, since it is toointricate for static meta-data. The ladder editor allows separateoperator and engineer commenting of a ladder. Operator comments arecompiled with the ladder.

2.4.2.2 Ladder Compilation

The ladder logic syntax can be checked at anytime by selecting the‘compile’ menu item. Note that this does not save the ladder. Thisaction opens an output window for status and error messages associatedwith the compile, similar to the functionality of the Microsoft VisualC++ compiler. Selecting a compile error displayed in the output willposition the editing cursor to the line or symbol containing the error(this is dependent upon the output of the compiler). If the userattempts to exit the editor without successfully compiling the sourcecode, a dialog is displayed. This dialog prompts the user to name andsave the ladder to the palette/library or discard it. Naming and savingthe ladder to the palette allows the user to re-use the uncompiledladder at a latter time. This action is necessary to keep the ladderrepresentation and compiled code in sync for the PLB. When the PLB issubsequently opened for edit, the user is prompted to select either thetemporary ladder logic or the last successfully compiled ladder logic.While modifying a ladder, the user can view the last successfullycompiled ladder by initiating another session of the IDA configurator.This view is read-only but allows the user to copy elements from thisview into the edited ladder. Interface between separate PLB compiler andframework output window to display compiler messages to the user.

2.4.2.3 Ladder Download

An installed ladder is part of a PLB and is assigned to an FBM via theBlock and Connection Editor. Several individual ladders can be loadedinto the same FBM. Once the Ladder logic is successfully compiled, itcan be downloaded into its assigned FBMs in response to either a requestfrom the Download Editor or from the file->download menu item. Whendownloaded, the editor stores the source and compiled code in theparameters of the PLB.

2.4.2.4 Ladder Diagram Reports

The PLB Editor provides the capability to generate a report for adefined ladder. The report is requested via standard IDA Reportingmechanisms. The content of the editors report is a graphical print outof the ladder as well as a cross reference of technical identifiers andtheir line locations with in the ladder.

2.4.2.4.1 Ladder Library

Individual rungs may be copied to other PLBs and can also be copied andstored in a library of ladder components for easy re-use through thepalette. A user can interact with the define logical palette. Thispalette contains the standard elements that can become part of a PLBladder. The user can drag and drop ladder components from the palette tothe ladder window to create a PLB's ladder. The user can also definetheir own palette and store off ladder components (elements, lines orrungs) for latter use. When copying line or rungs to the palette,elements retain their technical identifiers and descriptions.

2.4.3 Object Models

This section describes the object models associated with the PLB LadderEditor. Models are described for Ladders, Persistent Documents, andPLBs. The Ladder model shown in FIG. 96 is based on the FrameworkConnection Classes. A simplified version of the Ladder implementation ofthe Connection Framework model is shown in that the classes for LadderDefinition, Ladder Slot Definition, and Object and Connection TypeSpecifiers are not shown. Refer to Part 1 for an explanation and exampleof a Nest type Parent/Child Connection model and see the EnclosureLoading Editor section of this document for an example of how theDefinition classes are used.

The Persistent Document model shown in FIG. 97 is simplified in that itshows only the relationships from the Placeholders to their relatedParameterized objects and not the relationships to other objects(Appearance, View Type, etc.) as described in Part 1.

2.4.3.1 Ladder

The Ladder class is the top level container for a PLB ladder. Itcontains an ordered set of connections to Ladder Rungs. The description,last modify date, compiled binary version of the ladder, and lastcompile date are all maintained as parameters of a Ladder. Onlysuccessfully compiled Ladders are stored to the database for laterdownload. The last modify date and last compile dates can be comparedbefore downloading as a validity check. TechIDs and their user-defineddescriptions are maintained by this object. TechID descriptions can bemodified in the context of any symbol on a ladder diagram. When thedescription is changed for one symbol, every symbol referencing the sameTechID in the same ladder reflects the change. This class provides aninterface for basic syntax checking for the ladder. It verifies that theladder has a valid number of rungs (>0) and queries the rungs forvalidity. This class has the ability to generate a ladder source in anappropriate format for the existing ladder compiler. ClassRelationships:

-   -   This class is referenced by PLBs supporting ladder logic (shown        on the subsequent PLB Block model diagram).    -   This class is the container/parent for Ladder Rungs.    -   Ladder is derived from Parameterized Object, which supports        connections through its parameters.    -   Ladder contains an ordered set of Ladder/Rung connections.

2.4.3.2 Ladder Rung

A Ladder Rung is the only component which can be connected to a Ladder.The Ladder Rung maintains connections to an ordered set of Ladder Lines.It also contains a string parameter which acts as a rung descriptor. ALadder Rung consists of a primary line followed by zero or moresecondary lines. The primary line consists of Ladder Elements connectedfrom the left power rail to the right power rail in the diagram.Secondary lines can supply additional logic via “or” connections to theprimary line. The top most line is preferably the primary line. Thisclass provides basic syntax checking for the ladder rung. It verifiesthat the rung has a valid number of lines (>0) and queries the lines forvalidity, ensuring that the first line meets the criteria for a primaryline. This class can provide data in the file format necessary for theexisting ladder compiler. It supplies data specific to the rung andinvokes similar methods on the contained lines. Class Relationships:

-   -   Ladder Rung is derived from Parameterized Object, which supports        connections through its parameters.    -   Ladder Rungs are the only objects which are connected to        Ladders. Ladders are comprised of 1 or more rungs.    -   Ladder Rungs contain an ordered set of Ladder Line connections.        Primary or secondary lines are denoted only by location within        the ordered list of lines, the first line being the primary.    -   An association with a Placeholder is also maintained to support        supplying data for display purposes (see FIG. 97).

2.4.3.3 Ladder Line

The Ladder Line object represents one line of a rung in a ladder logicdiagram. One or more Ladder Lines comprise a Ladder Rung and one or moreLadder Rungs comprise a Ladder. A Ladder Line can either represent aprimary ladder line or a secondary ladder line. A primary ladder line isthe logical first line of a rung and is indicated by a power connectionfrom left power rail to right power rail. All connections to elements onsecondary lines preferably branch from or join the primary line. Usingthe Ladder Line Parameter Connection Type Specifier, this classdetermines what types of elements can be dropped into a given slot onthe line. Only Output Ladder Elements are allowed in slot 8 and onlyInput Ladder Elements are allowed in slots 1-7. This class providessyntax checking, based on whether it is a primary or secondary line. Ifthis line is the first in a rung, Ladder Rung can query this class tovalidate that it is a primary line. For all other lines in a rung, thisclass would be queried by Ladder Rung to determine if it were a validsecondary line. This class can provide data in the file format necessaryfor the existing ladder compiler. It supplies data specific to the lineand invokes similar methods on the contained elements. ClassRelationships:

-   -   Ladder Line is derived from Parameterized Object, which supports        connections through its parameters.    -   Ladder Lines are contained/connected only by Ladder Rungs.    -   Ladder Lines contain an ordered set of connections to Ladder        Elements.    -   Only Ladder Element types can be dropped into a Ladder Line.    -   An association with a Placeholder is also maintained to support        supplying data for display purposes (see FIG. 97).

2.4.3.4 Ladder Element

A Ladder Element represents a single logic symbol in a ladder diagram.It can represent either an input or output symbol, depending on the metadata contained in the object. Up to 8 Ladder Elements can be placed on asingle line of a ladder diagram. The type of element which can be placedin any given socket of a line is determined by data stored in theParameter Connection Type Specifier. The meta data stored in LadderElements determine if it is an Input Ladder Element or Output LadderElement. Input Ladder Elements can appear in any of the first 7 columnsof a line. Output Ladder Elements can appear only in the last column ofa line, and preferably appear in the last column of a Primary LadderLine. Ladder Elements can be queried to determine their element type.Ladder Elements contain parameters for TechID, and optionally, presetand reset counters. The TechID description is maintained by the Ladderobject, so it need not be maintained by the Ladder Element. Thedescription is retrieved from the list maintained by the Ladder object.Ladder Elements can provide data formatted appropriately for theexisting ladder compiler. When ladder elements are substituted for oneanother in a diagram, all corresponding parameters will carry over tothe new symbol. Values such as TechID, preset, and reset will carry overif the appropriate types are substituted. Any values which have nocounterpart in the new symbol will be lost. Class Relationships:

-   -   Ladder Element is derived from Parameterized Object, which        supports connections through its parameters.    -   Ladder Element contains a set of Source/Sink Connections for        input and output connections. These can be used for multiple        connections to other Ladder Elements.    -   Ladder Elements are contained by a Ladder Line.    -   Ladder Elements contain a set of Ladder Element Source        connections. These are connections to elements which appear        following this element    -   Ladder Elements contain a list of Ladder Element Sink        connections. These are connections to elements which appear        prior this element    -   An association with a Placeholder is also maintained to support        supplying data for display purposes (see FIG. 97).

2.4.3.5 Ladder Element Connection

Ladder Connection encapsulates connection data between two symbols on aladder diagram. These two symbols need not be on the same line. Thisclass has no knowledge of whether the connection is valid or not.Verification of connections is done by the PLB compiler. Each symbol ona line of a ladder diagram, has Connection Endpoints for power input andoutput. The first symbol on a line has only 1 implied input connectionfrom the power source and the last symbol on a line has only 1 impliedoutput connection to the power sink. Neither of these impliedconnections is actually instantiated. Input and output can each havemultiple connections, representing a logical “or.” Connections can onlybe made between elements adjacent on a line or between elements inadjacent columns of the primary line and one other line. ClassRelationships:

-   -   Ladder Connection is derived from the framework class        Source/Sink Connection.    -   Ladder Connection references one power input and one power        output from Ladder Elements.    -   An association with a Placeholder is also maintained to support        supplying data for display purposes (see FIG. 97).

2.4.3.6 Ladder, Rung, and Line Connections

Ladder, Rung and Line Connections are all Parent/Child Connections whichconnect the parent objects to one or more children objects contained bythe parent. These three classes may all be implemented as a common“Nest” class if there is no distinguishing behavior among the classes.Class Relationships:

-   -   These connections are derived from the Framework Parent/Child        Connection class which, along with Parameterized Objects,        provides the capability for to maintain ordered sets of        connections to Child objects.    -   Connections maintain relationships between the Parent        (container) and Child (contained) objects.

2.4.3.7 Ladder Rung Placeholder

This class holds all of the data associated with the drawing of a LadderRung. Drawing information such as rung description location, scale andselection status are maintained in this class. Class Relationships:

-   -   Ladder Rung Placeholder is derived from Parameterized Object        Placeholder.    -   Ladder Rung Placeholders are contained in the Ladder Document,        the collection point for all drawing data for a ladder.    -   Ladder Rung Placeholder maintains a reference its corresponding        Ladder Rung, to retrieve the data to display the rung.

2.4.3.8 Ladder Line Placeholder

This class holds all of the data associated with the drawing of a LadderLine. Drawing information such as scale and selection status aremaintained in this class. Class Relationships:

-   -   Ladder Line Placeholder is derived from Parameterized Object        Placeholder.    -   Ladder Line Placeholders are contained in the Ladder Document,        the collection point for all drawing data for a ladder.    -   Ladder Line Placeholder maintains a reference its corresponding        Ladder Line, to retrieve the data to display the line.

2.4.3.9 Ladder Element Placeholder

This class holds all of the drawing data for a Ladder Element. Thisincludes how to draw the symbol, where to place any associated text,etc. Class Relationships:

-   -   Ladder Element Placeholder is derived from Parameterized Object        Placeholder.    -   Ladder Element Placeholders are contained in the Ladder        Document, the collection point for all drawing data for a        ladder.    -   Ladder Element Placeholder maintains a reference its        corresponding Ladder Element, to retrieve the data to display        the element.

2.4.3.10 Ladder Element Connection Placeholder

This class holds all of the drawing data for a Ladder ElementConnection. This includes how to draw the connection, where to connectto endpoint objects, where to place associated text, error indication(if connection is invalid), etc. Class Relationships:

-   -   Ladder Element Connection Placeholder is derived from Connection        Placeholder.    -   Ladder Element Connection Placeholders are contained in the        Ladder Document, the collection point for all drawing data for a        ladder.    -   Ladder Element Connection Placeholder maintains a reference its        corresponding Connection, to retrieve the data to display the        connection.

2.4.3.11 Ladder Document

This class encapsulates drawing information to draw an entire ladderdiagram. This class contains information on scaling, orientation, andother style parameters. All other drawing information is maintainedwithin the contained classes. Class Relationships:

-   -   Ladder Document is derived from Persistent Document, from which        it inherits its drawing object collection functions and the        ability to be associated with a Sheet Template.    -   Ladder Document contains Ladder Connection Placeholders    -   Ladder Document contains Ladder Element Placeholders    -   Ladder Document contains Ladder Line Placeholders    -   Ladder Line Placeholder maintains a reference its corresponding        Ladder to respond to display requests.

2.4.3.12 PLB Block

Referring to FIG. 98 this class contains standard Block methods andmanages the parameters associated with PLB Blocks. Source code,interpretive code, and operator display code for the ladder aregenerated by the PLB Ladder editor and stored as Block parameters.

Class Relationships:

-   -   A PLB Block is derived from Block object, from which it inherits        containment of parameters and the ability to connect to other        Blocks.    -   The PLB Block maintains a relationship with its Ladder object        which is used to relate the Ladder diagram to the PLB Block code        parameters.

2.4.3.13 Temporary Source Code

This is a parameter which stores the logic source code of the associatedLadder while it is being edited and before it is successfully compiled.The PLB Ladder Editor presents the contents of this parameter forediting until it is successfully compiled, at which time the contentsare copied into the Last Compiled Source Code parameter and deleted fromthis parameter. If Full Versioning is not implemented, the transfer ofthe contents of this parameter to the Last Compiled Source Codeparameter may not take place until the code is successfully downloaded,in order to ensure that a copy of the source corresponding to therunning Block is preferably always available.

2.4.3.14 Last Compiled Source Code

This is a parameter which stores the logic source code of the associatedLadder. This code representation is used to compile interpretive codefor download to an FBM. This intermediate representation may not beneeded if the compiler contains the logic to translate the ladderdirectly into interpretive code.

2.4.3.15 Interpretive Code

This is a parameter which stores the interpretive logic code of theassociated PLB Block, which is downloaded to the FBM. This parameter isupdated by the PLB Ladder Editor as the result of successfully compiledsource code.

2.4.3.16 Operator Display Code

This is a parameter which stores the operator representation of the PLBBlock default display. This parameter is updated by the PLB LadderEditor following a successful compile of source code.

2.5 Swap Editor

The Swap Editor allows mapping parameters between different Block types.By dragging and dropping an Foundation Fieldbus Block from the ControlAlgorithm Diagram Editor palette and dropping it onto an IAS AIN Blockin a Loop drawing, a user can convert the AIN to an AI Block. The SwapEditor functions include dialogs which allow mapping parameters betweendifferent Block types so that the proper conversions take place duringswapping.

An object model supporting parameter swaps and conversions is readilyapparent in view of the teachings herein. Thus, by way of example, aswap object model can parallel the connection object model discussedabove and can reflect the permissibility of swapping between objects ofdifferent types. Use of that model can parallel the methodologydescribed above in Section 1.3.6 (Establishing a Connection), Level1—Object to Object. Unlike the connection object model (which retainsinformation about objects that are currently connected), a swap objectmodel need not retain information identifying objects that have beenswapped: it need only reflect permissible swaps. Moreover, theconnection object model need only reflect a single variety of swaptypes, not the multiple varieties provided for by the connection objectmodel.

Likewise, a parameter swap type object model can parallel the objectconnection type object model described above and can identify specificparameters between which mappings exist. A methodology for thisgenerally parallels that described above in Section 1.3.6 (Establishinga Connection), Level 2—Parameter to Parameter. Where applicable,parameter-to-parameter conversions can be maintained in parameter swaptype object model, as well. As above, the parameter swap type objectmodel need only reflect permissible mappings (not those that havealready been made) and it need only reflect a single variety ofmappings.

Data structures other than such can also be used to support parameterswaps and conversions. Thus, for example, mappings and conversions canbe represented in tables associated with the respective object types ortheir instances.

The swap editor provides an interface to the above described objectmodels or other data structures, permitting a user to create or editpermissible parameter mappings. The editor can utilize a graphicalinterface, e.g., similar to the control strategy editor, for thispurpose. Alternatively, or in addition, it can use dialog boxes, listboxes, check boxes, combo boxes, or other such interfaces, of the typeshown elsewhere herein, to allow the user to select mappings and specifyconversions.

2.6 Block Execution Editor 2.6.1 Overview

The Block Execution Editor provides the capability to view and edit acontrol station's block processing order. This includes providing thecapability to reorder blocks within a control level, reordering childcontrol levels within a parent control level, and control levels withina control station. The Block execution Editor manipulates a singlecontrol station's block processing order per instance.

2.6.2 Block Execution Editor Detailed Functionality

The Block Execution Editor is invoked from the IDA Navigation Tree byselecting a control level or control station and selecting BlockExecution Editor from the context popup menu. The Block Execution Editorprovides a view of the control levels and blocks assigned to a selectedcontrol station. Only those control levels assigned to a single selectedcontrol station will be displayed. The Block Execution Editor providescontrols necessary to allow the user to adjust the block processingorder for a selected control level, as well as adjust the processingorder of control levels within a control station. The Block ExecutionEditor provides automatic algorithms to optimize processing order, aswell as validate processing order. Control station statistics for theselected control station are available upon user request. The BlockExecution Editor also provides the capability to reassign blocks betweendifferent control levels as well as reassigning control levels to othercontrol stations. The reassignment of blocks to control levels andcontrol levels to control stations may be accomplished either bydragging a block from the editor to the IDA Navigation Tree, or byinvoking the assignment editor on a selected block.

2.6.2.1 Block Execution Editor User Interface

The default Block Execution Editor user interface is as presented inFIG. 99. The user interface is provided as an IDA Grid Editor view. TheBlock Execution Editor provides two distinct views of control levels andblocks in the tabular grid. The first view displays all blocks for aselected control level, as well as any child control levels of theselected control level which are assigned to the same CP as the selectedcontrol level. This view, which is referred to as the control levelhierarchy view, is displayed when the Block Execution Editor is invokedfrom a control level in the IDA Navigation Tree. The second viewdisplays all control levels assigned to a selected CP. This view, whichis referred to as the CP Hierarchy view, is displayed when the BlockExecution Editor is invoked form a CP in the IDA Navigation Tree.

2.6.2.2 Common User Interface

The user interface provides the name, type, phase, period, relativeexecution order, and estimated execution time for each block in thelist. For each control level in the list, relative execution order, thephase, period, and execution time is displayed. Upon initialization ofthe Block Execution Editor, the blocks and control levels are sorted byexecution order. The user is provided the capability to sort the rows ofthe grid by block type as well. Resorting is accomplished by selectionof the tab at the top the block type or execution order column. Doubleclicking control level in the list of control levels results in displayof that control level's blocks and child control levels. The previouslyselected control level's blocks and child control levels are removedfrom the display. The control level schedule editor provides a popupmenu to allow the user to invoke the Control Algorithm Diagram Editorfrom any block in the tabular grid, as well as the property page for anycontrol station, control level or block. Execution Order Modification.The Block Execution Editor provides the user the capability to manuallyand automatically modify the execution order of blocks and controllevels within a CP.

2.6.2.2.1 Manual Modification of Block/Control Level Scheduling Order

The Block Execution Editor provides the user the capability to manuallymodify the execution order of blocks and control levels within a CP.This may be accomplished in several ways. First, the user may manuallymodify the period and phase of a selected block or control level or agroup of blocks or control levels. This is accomplished by manuallyediting the period or phase field for the block or control level in thetabular grid. The grid allows inline editing of these fields. A secondway to modify the scheduling order is by moving block and control levelrows up and down in the grid. Selecting one or more rows in the grid andthen selecting the move up, move down, top, or bottom buttons willaccomplish this.

2.6.2.2.2 Schedule Optimization Algorithms

The Block Execution Editor will also provide automatic scheduling ofblocks based on optimization algorithms. Execution of the scheduleoptimization algorithms will be user selectable via menu items.Optimization algorithms will include block type and signal flow.

Results of optimization algorithms are displayed in the IDA outputwindow in its own tab. In addition, the Block Execution Editor providesalgorithms to perform load leveling for a CP. The Block Execution Editorprovides the capability to perform load leveling by compound.

2.6.2.3 Execution Order Validation

The Block Execution Editor provides the user the capability to validatethe currently scheduled execution order. The validation is either byphase overrun or signal flow. Phase order validation predicts phaseoverruns, and reports any overruns to the user. Signal flow validationassesses the relationship of connections and scheduled execution order,and reports any possible conflicts. Problems detected by either type ofvalidation do not prevent the user from assigning execution order, butinstead are intended to provide warning of possible scheduling problems.The results of validation are displayed in the IDA output window in itsown tab. Execution order validation is made available outside of theBlock Execution Editor for use by other IDA applications, including butnot limited to download services.

2.6.2.4 Reassignment of Blocks and Control Levels

The Block Execution Editor provides the capability to reassign blocks todifferent control levels, as well as reassign control levels todifferent control stations. This is accomplished by dragging theselected block or control level from the tabular grid and dropping itonto a control level or control station on the IDA Navigation Tree.

2.6.2.5 Station Statistics

The Block Execution Editor provides the user the capability to viewstation statistics for the selected CP. Statistics include total, free,and used station memory (as depicted in FIG. 100), relative phaseloading, overall processor load, BPC, and total blocks assigned to CP.The Block Execution Editor provides textual and graphical representationof station statistics.

2.6.3 Tutorials

-   -   Tutorials on adjusting the control levels and block process        order and phasing are part of the editor.

2.6.4 Object Model

The object model for Control level and Control Stations/Processors isshown in FIG. 101.

2.6.4.1 Control Station

This class holds an ordered list of control levels associated with aControl Station. Class Relationships:

-   -   Control Station is derived from Parameterized Object Collection,        from which it inherits the ability to maintain ordered lists.    -   Control Station maintains references to its associated Control        levels, which are used to provide access to Control level data.

2.6.4.2 Control Level

This class holds an ordered list of Blocks associated with a Controllevel. The Block, Loop, and Block Collection classes are discussed inother sections of this document. Class Relationships:

-   -   Control level is derived from Block Collection, from which it        inherits the ability to maintain ordered lists.    -   Control level maintains a reference to its one associated        Control Processor.    -   Control level maintains references to an ordered list of        associated Blocks, which are used to provide access to Block        data.    -   Control levels maintain references to an ordered list of child        control levels    -   Control levels maintain assigned execution order    -   Control level maintains references to associated Loops. This        association is used by Loops to aid in bulk and default Block        assignments to a Control level and by Control levels for “where        used” reporting.

2.6.4.3 Blocks

This class holds a reference to the control level to which it isassigned. Blocks maintain a reference to the control level to which theyare assigned

2.7 Tag List Editor 2.7.1.1 Overview

For the purposes of the following discussion, “tag list” refers eitherto the generic concept of tag lists or to the externally generated taglist being imported and exported from IDA while “Tag List” refers onlyto the IDA database object of that name. A tag list is a collection ofdata describing the physical I/O, its labeling, its connection with theDCS (Distributed Control System) and the loops involved in controllingthe process using the I/O. It is sometimes the output from (or the inputto) a Plant Design System, such as the InTools™ product of IntergraphCorporation. Since changes to this data can occur either within IDA orwithin the Plant Design System, it is necessary to be able to exchangethis data in a suitable form. The most common format for data exchangeis delimited ASCII files and this is one medium used by IDA. Inaddition, IDA can import and export tag list data in DBF format forcompatibility with FoxCAE.

The Tag List Editor enables the user to create, import, merge, edit andexport tag lists for use in the bulk generation of control loops andBlocks. A merge combines the changes made to an external tag list intothe IDA Tag List, making edits and creating and deleting objects asrequired. An import operation replaces the IDA Tag List with theexternal tag list, again editing the IDA database as necessary. Ineither case, user permission is preferred before the edits are committedto the IDA database.

A tag list can be viewed as a collection of rows, similar to aspreadsheet or relational database table. Each row contains an orderedlist of items which define some aspect of a control loop (input andoutput hardware addresses, loop name, Block descriptions, alarm limits,etc.). Every row in a given tag list is identical in structure; i.e.each row contains the same items (parameters) in the same order as everyother row. However, not all items are required to have a value assignedto them. For example, if the tag list has two string items which arenormally merged together to form a Block description, either or bothitems may contain a null value. As a result of this requirement, all taglist items, even those which represent numbers, may be stored with aFramework defined data type of NULL.

The purpose of the tag list is to provide data for the construction ofcontrol loops. The bulk loop generation facility (initiated from the TagList Editor) uses items in the Tag List Rows as input. Normally, eachrow in the Tag List represents an input or output point in the plant,designated by FBM and point number. One column in the table identifiesthe Loop Template associated with this I/O point. Multiple rows whichspecify the same Loop Template are allowed.

The bulk generation process uses the specified Loop Template and the TagList to construct the blocks which comprise the loop. When the userselects one or more Tag List rows and requests loop generation, the datacontained in the Tag List is “attached” to the Loop Template(s)designated by the Tag List Row, the data contained in the row ispropagated to the Blocks in the Loop Template using the rules specifiedby the Loop Template, the Blocks and Connections specified in theTemplate are generated and the result is stored as a “Template DerivedLoop”.

The Loop Template contains one or more “Blocks” which represent the datacontained in a single Tag List Row. These “Blocks” represent Tag ListRows as sets of Parameters which can be used in connections to controlBlocks. The bulk generation process performs a “mail merge”—likeoperation by substituting the data contained in each row into theappropriate Block in the Loop Template and generating instances of theBlocks specified in the Template. The data in the Tag List is propagatedthroughout the Loop. This process performs user defined stringmanipulations on the Tag List Items to create values for parameters ofBlocks being built within the loop. For example, a Block description maybe mapped directly from a specified Tag List Item to a specific Block(or Blocks) DESCRP parameter or a Block's high alarm limit may be set to80 percent of the Tag List high scale item.

Like Blocks, Tag List Rows are homogeneous collection of ParameterizedObjects where each Tag List Item within a row is a Parameter and theParameter name defines the “column” name. For purposes of importing,editing and exporting tag lists, the Tag List is presented to the userin a data grid format where each Tag List Row is presented as a row in adata grid and each column represents a Tag List Item. Thisrepresentation is used within the Tag List Editor.

The other “view” of a Tag List Row is that of a Block. This is therepresentation used by the Control Algorithm Diagram Editor to display aTag List Row on a loop drawing. When this representation is in use, thevalues of the Tag List Items appear (and can be edited) as parameters ofthe “Block”. Since Tag List Rows generally describe either a physicalinput or a physical output, IDA reserves the Block types TAGIN andTAGOUT to represent input rows and output rows, respectively. Editingthese parameters in the Control Algorithm Diagram Editor is functionallyequivalent to editing them in the Tag List Editor. When editing the TagList Row Items in a Block view, the items are presented on a propertysheet, similar to other Blocks.

When creating a simple (non Template-Derived) Loop, the user adds TAGINand TAGOUT Blocks by dragging and dropping from a palette, similar toany other Block type. Dropping one of these Blocks onto a Loop drawingresults in the automatic addition of a corresponding row in the TagList. Tag List rows related to simple Loops have a blank value in theLoop Template element.

Since the main purpose of a Tag List is to be used in loop and Blockgeneration, there is a minimum set of parameters to support thatfunctionality within IDA. This starter set is supplied by IDA but may bemodified by the user. In addition, the user may define additional TagList Items for use in parameter propagation or documentation. However,only one Tag List definition (the names and order of parameters within atag list row) is allowed per IDA configuration. The reason for this isto simplify managing Tag List information and maintainingsynchronization with the as-built configuration.

As discussed, above, of the two representations used within IDA for agiven Tag List Row; tabular and Block, the tabular view is the one usedby the Tag List Editor. Using a tabular interface, like the one shown inthe user can edit data in existing rows, add new rows or delete existingrows. The columns shown in the figure include (from left to right); thecompound to which the generated blocks are currently assigned, the I/Otag (the user/customer name for the I/O signal), the Loop tag (name ofthe Template Derived Loop associated with these rows), two columns ofdescriptive text (used to propagate into the Block descriptions andalarm message text parameters), the type of block connected to thephysical input or output, the instance of the specific block type in theLoop Template (if the Loop Template specifies two AIN Blocks, they arelabeled A1 and A2), the IOM_ID is the primary letterbug of the FBMcontaining the point, and IOMIDE is the letterbug of the FBM extension.Not shown in the figure is the Loop Template column used to specify theassociation between these rows and the Template used to generate theBlocks. Users can sort the Tag List by selecting any of the columnheadings. Color or icons are used in the L-tag element fields toindicate if the Loop to which the Tag belongs has been built orgenerated.

For use in importing and exporting external databases, a dialog boxbased interface is used. Shown in the figures are examples of dialogsfor mapping fields between ASCII input files or database tables and thetag list “fields”. The displays shown FIG. 103 et seq., include thosetypically used with Plant Design Systems in general and InTools inparticular (to preserve the existing FoxCAE functionality, InToolscompatibility is a requirement). The dialog box shown in FIG. 103 isused to map an ASCII, delimited list into the appropriate Tag ListItems. Once a text (ASCII) file is chosen, a count of the number ofdelimited fields per line is made and the input file is verified tocontain exactly that many fields in every line. Next the upper left listin the dialog is generated, showing one line per field, numbering eachfield and showing the content of each field in the first line of thefile. The upper right list shows the attributes of a each Tag List Itemin a Tag List Row.

If a mapping exists between a field and a Tag List Item, selecting oneof them from either list will scroll the opposite list and highlight thecurrent mapping. Associations between the two lists are made byselecting an item from each list into the lower list using the up (ordown) arrows. The bottom list shows the current mappings. The “Show”button shows a grid with the entire contents of either the Tag List orthe ASCII file. The “Start” button causes the input file to be read andthe data mapped to the Tag List as specified in the mapping. The “Save”button saves the mapping. The “Cancel” button cancels the operation. Seethe Import/Export Editor Section for further discussion on import/exportfiles and mapping.

FIG. 104 shows the selections used in the illustrated embodiment toexport a Tag List in delimited ASCII format. In this example all of theTag List Items have been assigned (mapped) to fields in the text outputfile. The human interface components have the same actions as describedin the previous figure with the exception that the “Export” buttoncauses the creation of the text output file.

The dialog shown in FIG. 105 is used strictly to establish the mappingbetween the Tag List and external database tables. Its operation issimilar to that described for previous dialogs but the actualimportation of the external table data is done in a separate step from adifferent part of the user interface.

An interface for defining the Tag List Row structure by specifying theTag List Items and their positions within the row is used. Thisinterface is identical to that used by the Block Definition Editor sincethe Tag List Items are Parameter Definitions and the Tag List Rowspecification is actually a defining Block. The Tag List Editor willshare the same dialog classes used to implement this functionality inthe Block Definition Editor, with methods overridden, where necessary,to enforce the restrictions required in Tag List construction. As aresult, the detailed interface description is the same as in the BlockDefinition Editor. It is not necessary that every Tag List Item be usedwithin IDA. Some fields in external tag lists are used for documentarypurposes by the Plant Design System using the list and may not beapplicable to IDA. However, to preserve an interchangeable format with aPlant Design System, fields which are not accessed by IDA should stillbe defined as Tag List Items so that the export functionality preservesthe Plant Design System fields intact. Users can add Tag List Items tothe Tag List Definition, but only authorized developers are allowed todeleted or modify the implementation standard items.

2.7.1.2 Functions

The functionality of the Tag List Editor can be divided into five parts;creation, import, merge, edit and export. All import and exportfunctions can use either delimited ASCII text files or database tables.The bulk database generation facility is accessible through the Tag ListEditor. The user can select a loop (one or more Tag List Rows whichshare a common loop ID item), or a number of loops on the Tag List andinvoke the generation of the associated control database elements. Thehuman interface for this operation is a menu entry to invoke thefeature, a dialog box showing the loops currently selected in the TagList (and allowing modification of the selection) and a progress bar(with a cancel button) showing percent completed during the operation.If cancel is selected, the database is rolled back to its state prior tothe operation.

2.7.1.3 Class Descriptions 2.7.1.3.1 Tag List

Referring to FIG. 106 a Tag List is responsible for containing andcontrolling access to Tag List Rows. It is derived from the BlockCollection Application class. Class Relationships:

-   -   Tag List is derived from Block Collection (which, in turn, is        derived from the Parameterized Object Collection Framework        class) in order to present a “Block collection compatible”        interface accessed as a Block collection by other IDA        applications (including Placeholder relationships).    -   Tag List only allows “Blocks” of Type Tag List Row to be added        to its collection, overriding the methods of its parent classes,        where necessary.    -   Tag List delegates the balance of the maintenance of its        collection of rows to its parent classes.

2.7.1.3.2 Named Mapping

A Named Mapping is responsible for correlating fields in an externaldata source with the names of Tag List Items. The relationship is usedby the Import/Export Manager during its operation. The object is shownhere as it is part of the Tag List object model. See the Import/ExportManager description, elsewhere in this document for details.

2.7.1.3.3 Tag List Row

A Tag List Row is responsible for containing and controlling access toall the Tag List Items, their definitions and their values. It isderived from the Block Application class. Class Relationships:

-   -   Tag List Row is derived from Block (which, in turn, is derived        from Parameterized Object Framework class) in order to present a        “Block compatible” interface when displayed on a loop drawing as        a Block or accessed as a Block by other IDA applications. Other        typical Block relationships, such as to Placeholders are        maintained through this inheritance. See the Control Algorithm        Diagram Editor section of this document for further description        of Block relationships.    -   Tag List Row Definition is a “defining” Parameterized Object and        contains no reference to a defining object. Methods in the        parent classes are overridden to provide enforcement of this        rule.    -   Tag List Row has only one parameter group, with the group name        of “Row”. All definitions are contained in this group. Methods        in the parent classes are overridden to provide enforcement of        this rule.    -   Tag List Row delegates the balance of its behavior, including        parameter facade generation, and parameter value overriding to        its parent classes.    -   Tag List Row maintains a Block Connection with one and only one        I/O Block Type (AIN, AOUT, etc.), through which it associates a        Block I/O parameter to an FBM point number. The I/O signal type        match is the only Tag List Item which is strongly typed; all        other items may be connected as the user sees fit. See the        Control Algorithm Diagram Editor section of this document for        further description of Block Connection relationships.    -   Tag List Row maintains a Nest Connection with an FBM Module,        through which it associates an FBM point number to an Block I/O        parameter. See the Enclosure Editor section of this document for        further description of this relationship.

2.7.1.3.4 Tag List Row Definition

The Tag List Row Definition is a Tag List Row which acts as thedefinition for the entire project. Both the Tag List and the Tag ListRow hold a reference to this definition. Only one Tag List RowDefinition exists so that all rows have exactly the same “columns”.Class Relationships:

-   -   Tag List Row Definition is derived from a Tag List Row. Since        this derivation inherits from Block, some of its methods are        overridden to allow enforcement of the rule that it be the only        definition of a Tag List Row.    -   Tag List Row maintains a reference to Tag List Row Definition as        does Tag List.

2.7.1.3.5 Tag List Item

A Tag List Item is a specialization of the Framework ParameterDefinition class and contains all the behavior associated with thatclass. Class Relationships:

-   -   Tag List Item is derived from the Framework Parameter Definition        class.    -   Any edit control or other Block related parameter attributes        (besides type) are for use when the Tag List Row is being        manipulated as a “Block” by other IDA applications, for        instance, while using the property sheet view of the Tag List        Row to modify parameters while editing a Loop drawing.

2.8 Download/Upload Manager 2.8.1 Overview

Configuration data needs to be exchanged between the Operator Interface(OI) applications of IAS and IDA. This involves loading controlalgorithms into control stations as well as loading configurationinformation into OI applications. Loading a list of collection pointsinto a Historian is an example of loading configuration information intoOI applications.

The context menu associated with IDA objects includes downloadselections for appropriate objects. The download selection invokes theDownload Manager Editor to select targets for the download and tomonitor the download process. Some objects may provide a second non-GUIselection. This non-GUI download function invokes the Download Managerwho determines the download target from the selected object and does notprovide validation or error recovery. The non-GUI download provides aquick download mechanism for simple downloads such as downloading acontrol algorithm to a control station.

The Download Manager is an IDA dialog editor. The Download Manager usesthe context of the object from which it was selected to display a listof target systems. The Download Manager interacts with the user toselect the download targets, validates configurations, and provideserror recovery. The Download Manager uses the Download Service functionsfor executing the download. Since download involves data transmissioneither to control stations or OI applications, there are two DownloadServices, Download Service for Control Stations and Download Service forApplications. Separate sections in this document detail these services.

Similarly to the need to load configuration data into OI applications isthe need to merge in OI modified data. The Security Subsystem providesan example of this need. Configuration of the IAS Security Subsystem isthrough IDA, using the download functions. However, the SecuritySubsystem contains the ability to change user passwords. The uploadfunctions of the Download-Upload Manager provide the functionality formodifying IDA objects from external sources.

The download functionality requires IDA objects to be in a checked instate. A user preferably completes modifications to the IDA objectsbefore downloading configuration data. Interactions with controlstations in a simulation mode may be an exception to this rule. Theupload functions similarly require IDA objects to be in a checked instate. However, the upload functions force a check out of the IDA objectbefore merging in the uploaded data. The user is responsible for thecheck in of the modified objects, it is not done automatically by theDownload-Upload Manager. See Part 1 for a more complete description ofcheck-in, checkout, and versioning.

2.8.2 Functions

The Download-Upload Editor is divides into four related categories:

-   -   Interaction with the user to define a download.    -   Interaction with Download Agents to perform the download    -   Uploading external data, displaying differences, and providing        merge functionality.    -   Error recovery

The following subsections describe the user interface displays andfunctional details.

2.8.2.1 User Interaction

IDA provides the ability to download and upload configuration datato/from applications running in the various hardware stations. Downloadfunctions are provided for downloading process displays, historianconfiguration data, and alarm configuration data to the appropriatestations/applications. Download functions provide options fordownloading just the changes or downloading the entire object.

A dialog, such as in FIG. 107, displays the possible targets fordownloading the selected object. The dialog is invoked either through amenu selection or through the context menu of an object. The dialog usesthe currently selected object in the Navigation Tree to determine thedownload source. The dialog gives the user the option of downloadingjust the object selected or the object and all of its children. Theobject to download, or the object and its children, determine thepossible download entities. These targets display as a tab controlwithin the dialog. In FIG. 107 tabs show that control algorithms,FoxView displays, and Message Manager information is available from thePlant1 object or one of its children. Selecting the tab for a downloadtarget displays the possible targets for the download. In FIG. 107, aHistorian download is selected, displaying a list of all configuredHistorians. From the list, the user selects the Historians to receivethe download. A check box specifies that Historians will download. Theuser does not have to download to all possible targets or all possibletypes. If the “Select for Download” check box is unchecked, Historianinformation does not download. The dialog also allows the user to definewhat parameters to download, just modified parameters or all parameters.The all parameters choice provides a second choice between downloadingall the parameters or downloading the non-user settable parameters.Through these selections the user controls the download process.

A download button initiates the download process. Part of the downloadprocess is the verification of the object to download. A second buttonprovides the ability to invoke the object verification withoutperforming a download. It is possible for a download to a target to notcomplete and remain pending. The Download Service servers maintain thelist of pending request. Another button provides the ability to view thequeue of pending requests in each server.

2.8.2.1.1 Validation

During the editing process, it is legal for information to be leftincompletely defined. The connections between blocks in a loop may belinking to blocks not yet defined. Prior to downloading, theconfiguration must preferably be completed. The validation processrequests each object to validate itself. A window displays informationabout validation failures. The validation process does not stop aftererrors are found; the process completes to find all errors. However, ifvalidation finds any errors the download process does not initiate.

2.8.2.1.2 Download Agent—Control Stations

The Control Station Download Agent transmits control algorithms tocontrol stations. The Download Manager invokes the Download Agent foreach object to download to a control station. For control algorithms,the target is determined not by the user but by the block to compoundassignment and by the compound to control station assignment. Forcontrol stations downloads the Download Manager only sends the DownloadAgent the object to download and the download options.

2.8.2.1.3 Download Agent—Operator Interface Applications

Operator Interface (OI) Download Agents provide extraction of data fromIDA objects for download to Operator Interface (OI) applications. TheDownload Manager interacts with each OI Download Agent to determinewhether the agent interacts with the selected IDA object. If the agentdoes not interact with the IDA object, then it will not appear in thetarget tabs. The Download Manager queries each OI Download Agent for alist of potential targets. These targets are displayed in the listcontrol for the target tab. The Download Manager invokes each OIDownload Agent selected with the source object and the selected targetobjects to perform the download.

2.8.2.1.4 Download Progress

As the Download Manager process each object, it provides the userinformation about the progress. In addition to displaying how manyobjects have been downloaded, the Download Manager interacts with theDownload Agents to display the progress from the Download Agents inprocessing the requested object.

2.8.2.1.5 Download Server Status

The Download Agents rely on Download Servers to transmit the informationto the target systems. A target system may not respond to the server.Rather than fail the entire download, servers may queue up downloadrequests. Whenever the target system becomes available, they communicatewith the server to request queued downloads. A dialog, displays thequeued requests in a server. This dialog allows the user to removerequests from the pending queue. The dialog is provided by the DownloadManager through interactions with the Download Agents.

2.8.2.2 Error Handling

During a download, if a Download Agent reports an error, the user isgiven the choice whether to continue with the download or whether tostop the download. The Download Manager maintains a record of allinitiated downloads in the IDA database. In the event that IDA itselfcrashes during a download, during IDA startup, a message reportsincomplete downloads. The message allows the user to restart theDownload Manager with the interrupted request. Any objects successfullydownloaded do not re-download. Status information in each IDA objectindicates whether the download completed for that object.

2.8.3 Class Descriptions

Referring to FIG. 108, the Download Manager maintains a persistentdocument derived from the framework Persistent Document object. TheDownload Manager Persistent Document maintains information aboutinitiated downloads and their status. This information is used for errorrecovery. The Download Manager Persistent Document also containsparameters defining the relationship between download types and DownloadAgents. The Download Manager relies on the objects requesting downloadservices to contain parameters specifying the download types and the OIDto a download target.

2.9 Control Station Download Services 2.9.1 Overview

The Control Station Download Services is responsible for downloadingcontrol algorithms to IAS control stations. As changes are made to add,modify or delete Blocks, or Control Levels, action records are createdby the Block and Control Level objects to keep track of what actions arerequired to download the changes. Download requests are handled by theDownload Agent, which is a non-persistent object created by otherobjects which have download methods (Blocks, Control Stations, ControlAreas). Once the Download Agent is created, the requesting object passesit an OID or a list of OIDs and an argument indicating what type ofdownload operation to perform: download just the required changes, ordownload all parameters to refresh the Control Station data.

The Download Agent uses the OID(s) to create action records and obtainparameter values from the Control Levels and Blocks and builds anoptimized ordered list of actions to ensure proper delete/add sequencesand to group actions by Control Station and Control Level. The Agentthen contacts the Download Service to request a reference to an ICCAPIobject. The Download Service manages Control Station interfaces andcreates request queues when there are concurrent download requests forthe same Control Station. The Download Service returns either a busyindication (if another Download Agent is currently using the requestedControl Station) or a reference to the ICCAPI object created by theService for a specific Control Station. The Download Agent uses thereference to make the appropriate ICCAPI calls as it processes itsDownload list. If a busy indication is received (meaning the CP is beingaccessed by another process), the Download Agent will abort the downloadand inform the user. Likewise, if any Block download returns an error,the Download Agent will abort the download. The Download Manager will beresponsible for querying the user for the next action to take—retry orabort altogether.

As each successful download action is completed, the Agent notifies theControl Level and Block to delete its action record. Upon completing thedownload request, the Download Agent returns a copy of the OID list tothe original object which requested the download, indicating the successor failure of each requested download entry.

As a download is initiated, the Download Agent will mark the associatedControl Station as “Downloading”. If the download is successful, theControl Station state becomes “Downloaded”. In the event of a downloadfailure, the Control Station state will remain “Downloading”. At IDAstartup, a check of Control Stations will be made, and if any ControlStation indicates a download failure (by having the Control Stationstate of “Downloading”), the user will be notified of the past downloadfailure.

The Download Agent will also handle requests for Control Stationcheckpoints and initializations.

Download operations will fully comply with and support the versioningdescribed in Part 1 as versioning becomes available.

2.9.2 Functionality 2.9.2.1 Download Agent

The Download Agent is a non-persistent object that is temporarilycreated by objects or IDA editors to process download requests toControl Stations. The Agent accepts download requests in the form ofOIDs (a list of Block or Control Level OIDs, or a Control Area OID) andcreates action record information from the Control Levels' Block list tobuild an optimized list for issuing ICCAPI calls to the respective IASControl Station. Block ordering is a function of the Control Level. Thedownload request also contains arguments indicating what type ofdownload to perform. The download type argument is used to specify oneof the following download actions:

-   -   only changes made since the last download    -   all Block parameters

The Download Agent contacts the Download Service to obtain a referencefor an ICCAPI object to use for each Control Station. The Agent formatsICCAPI instructions, based on the action records in its optimized list,and invokes the appropriate method of the ICCAPI object to process theactual download to the physical Control Station.

For successful download actions, the Download Agent notifies therespective Block to delete the action record and logs the action assuccessful in the download request list. Unsuccessful download actionsare marked as failed in the download list and further processing isaborted. When the Download Agent is finished processing the downloadrequest it passes the original request list, with download status filledin for each entry, back to the original requestor. A successful downloadwill be followed by a checkpoint of the Control Station. The Agent thennotifies the Download Service when download processing is complete, sothat the Service can delete the ICCAPI object.

The Download Agent will process one download request at a time. If theDownload Agent is currently downloading, any subsequent attempts todownload will be rejected until the current download is complete. Toprovide a means of recovery in the event of a system or Control Stationfailure during a download, the Download Agent will mark each object witha “Downloading” attribute just prior to calling the ICCAPI. Once thedownload of the object is successful, the “Downloading” attribute iscleared. If the download of the object fails, the “Downloading”attribute remains and the download is aborted.

2.9.2.2 Download Service

The Download Service is a service that runs on the IDA database serverplatform and manages requests to create ICCAPI objects to be used forissuing download actions to specific Control Stations. The Service keepstracks of which Control Stations are currently in use by DownloadAgents. If multiple requests for the same Control Station are received,a “busy” error is returned. This error is returned to the callingobject, allowing the object to query the user for what action totake—abort the download or wait for the current download for the givenControl Station to complete. The Download Service creates ICCAPI objectsfor specific Control Stations and passes references to these objectsback to the requesting Download Agents. Upon receiving notification thata Download Agent has completed its download tasks, it deletes the ICCAPIobject. The Download Service processes multiple downloads to multipledifferent Control Stations at one time. In the event of a Download Agentor network failure, the Download Service terminates a Control Stationconnection if no communication is received from the station's DownloadAgent within the preceding three minutes.

2.9.3 Class Descriptions

Since the Download Services only reads and writes existing Applicationand Framework database objects, it has no object model (aside from theMFC objects used in its implementation and human interface). Theverification features of the services use the Framework-suppliedrevision and change management functions of the objects involved in itsoperation. See FIG. 109.

2.9.3.1 Blocks

Blocks maintain a status attribute, indicating their current downloadstate:

-   -   Downloaded—no modifications since last download    -   Added—not yet created in a physical Control Station    -   Deleted—deleted by user, but not yet deleted from the physical        Control Station    -   Modified—changed since previous download    -   Moved—moved to another Control Level or renamed, but not yet        deleted from the physical Control Station

The status attribute is kept consistent with any existing action recordsand is used to indicate to other objects or applications if the Blockneeds to be downloaded, or if a special visual attribute needs to beset. For instance, the Project Manager would use a special icon on aTree or List view to indicate that a Block had been deleted, but not yetdownloaded.

Blocks add the appropriate action records in response to user actions,including:

-   -   Adding a Block    -   Deleting a Block    -   Modifying Block Parameters    -   Reassigning a Block to a different Control Level    -   Renaming a Block    -   Changing the Block processing order within a Control Level

Blocks also provide the appropriate parameter list and values inresponse to Download Client requests to download:

-   -   New actions—action records not yet processed    -   All parameters    -   All non-settable parameters—only those parameters which cannot        be modified by operators at run-time

Blocks have two-way associations with a Control Level. A Control Leveluses its associations to keep an ordered list of its Blocks. A Blockuses its association to identify the Control Level to which it iscurrently assigned. When a Block is re-assigned to another ControlLevel, it creates a Delete action record that contains the Name and OIDof the old Control Level and deletes its association with the oldControl Level. It then creates an association with the new Control Leveland creates an Add action record with the Name and OID of the newControl Level. The old Control Level maintains its association with theBlock until the reassignment is downloaded, at which time the Blocknotifies the old Control Level to delete its association.

2.9.3.1.1 Block Action Records

Action records are non-persistent objects created in response to usersadding, deleting or modifying the Block. They are used to determine whatactions are required in response to a download request. Each actionrecord has attributes to indicate:

Action Type:

-   -   Add—download all parameters    -   Modify—download only parameters marked as modified since last        download, including    -   changed Block processing order within a Loop.    -   Delete—delete block from the Control Level    -   Block Name—needed to handle cases where Block name is changed    -   Control Level Name    -   Control Level OID    -   Position—Block processing position within a Loop, used by the        Download Agent    -   to determine Block position within a Control Level.

Status:

-   -   New—no download action initiated (default state when Record is        created)    -   Pending—download request is in progress but not yet successfully        completed

Control Level Name and Control Level OID are used to determine if adelete action requires deleting the Block from the database (Name andOID match) or if the Block should remain in the database, but needs tobe deleted from an existing Control Level because the Block has beenmoved to another Control Level or the Control Level has been renamed(Name and OID do not match). Action record status is used to trackprogress of download requests. Status is changed from New to Pendingwhen the Block responds to a request for download information from theDownload Client.

Action records are deleted by the Block in response to notification fromthe Download Agent that the action has been successfully completed.

2.9.3.2 Control Levels

Control Levels contain status similar to Blocks and maintainassociations with Control Stations similar to the associations Blocksmaintain with Control Levels.

2.9.3.2.1 Control Level Action Records

Control Level action records are built similarly to those used forBlocks, except that the Control Station names and OIDs are used in placeof the Control Level names and OIDs in the Block action records.

2.10 Operator Interface Applications Download Agent and Server 2.10.1Overview

The Operator Interface (OI) Download Services are responsible fordownloading IDA configuration information to IAS applications.

2.10.2 Functionality 2.10.2.1 Download Agents

The Download Agents interact with the Download Manager for userinteractions in selecting targets, and providing progress information.The Download Agents rely on the Download Manager for error recovery.

The Download Agents provide a query function used by the DownloadManager for determining whether the agent handles the selected sourceIDA object. The Download Manager passes in an OID for the selected IDAobject. The OID's type is tested for determining whether the agent dealswith the object. The agent also checks child collections of the objectif the Download Manager specifies the children option.

For source objects which the Download Agent handles, the Download Agentreturns the list of possible target stations. The Download Agents returneither a string array of names or a list of IDA object definitions. IfIDA object definitions are returned, the Download Manager displays allinstances of the object definition.

Once a download initiates, the Download Agents interact with the sourceIDA objects to extract information as needed by the OI application. Thisinformation is replicated to all target systems using the ReplicationServer. During the download process, the Download Agents interact withthe Download Manager to display progress information.

2.10.2.2 Download Service

The Download Service for OI downloads is comprised of two applications.The first application is a generic application which replicates datafiles, created by the Download Agents, to a specified list of targets.The second application is specific to OI applications and performs theneeded functionality to import the replicated data into the OIapplication. The OI import application is specific to each OIapplication. Responsibility for the implementation of the importservices resides with the OI application team. The Download Agent mayinteract directly with an OI Application Server to import the data,without invoking replication services, if appropriate.

2.10.3 Class Descriptions

The Download Agents are transient classes with no IDA objectdefinitions. The interaction between the Download Agents and the IDAobjects is through the parameterized object interface. Specificparameters are extracted from the IDA objects to create the OIApplication data set. The parameters to extract are either predeterminedby the Download Agent or specified as a parameter group in the IDAobject.

2.11 Historian Collection Point Editor 2.11.1 Overview

The Historian Collection Point Editor is responsible for creatingHistorian configuration files which can be used to add collection pointsto IAS historians. The information used to configure a point for eitherHistorical collection facility is the same. The information is a set of“fields”, one set per parameter, which includes:

-   -   The complete name of the point to be collected which contains        the compound name, block name and parameter name within the        block.    -   The delta (or amount of change in value) required to receive the        point from the control station.    -   The frequency with which the point is to be stored when it        changes.    -   The duration for which to store the values being collected or        the number of values to be stored.    -   A description of the point (similar to block description but on        a per parameter collected basis).

An assignment for historical collection can be made for any“connectable” IAS block parameter. Each assignment is made to a singleHistorian (one per configuration file). Any connectable parameter of anyblock may be designated for Historian assignment. The designation can bemade to the Block Definition or to any Derived Block Definition (e.g.PIDA (default) vs. PIDA (Flow)) or to a specific block instance (thePIDA named XXX in the compound YYY). The designation is a data inheritedfeature. That is, if the measurement (MEAS) of the PIDA (default) isdesignated then so is the measurement of the Flow PIDA and all otherdescendants and instances of PIDA. If the designation is made to theFlow PIDA then all Flow PIDA instances will share the designation.

Historian names, types, servers and capacities are extracted from systemconfiguration files or may be entered and edited manually. Manuallyentered information is not exportable back to the system configurationfiles. The Historian used for collection is selected on a per Compoundbasis. That is, all designated points in the blocks in the Compound areassigned to the Historian selected for that Compound. All theassignments for a given Historian are aggregated into a singleconfiguration file. When Loops are assigned to a Compound all theHistorian collection points in the Blocks in the Loop are assigned. Thisis true of both Template Derived Loops and Simple Loops. Individualinstances of Blocks which have assignments will “inherit” the Historianassigned to their containing Compound.

2.11.2 User Interface

New Historians are created in one of two ways; importing the Historianconfiguration data via the Import/Export Manager or by selecting“New”-“Historian” from a menu pick. The information includes theHistorian name and capacity. The Historians created or imported displayon the Plant Tree View. A set of screens is provided to allow the userto define and manage Historian information (contained in the Historianclass, below). These screens have options to import the Historianinformation from the system configuration or to enter the data manually.A dialog is provided to manage the assignment of Compounds to individualHistorians. This operation is tied to Loop configuration/Loop assignmentto Compounds and the dialog is accessible from the Control AlgorithmDiagram Editor. It is also available as a right click option fromseveral locations (anywhere a Compound is displayed for editing). It isalso possible to do Compound assignment by dragging a Compound onto anHistorian. Shown below is the interface used by FoxCAE to perform asimilar function.

FIG. 110 is an overview display of the available Historians, theCompounds assigned to each and the Blocks within each compound. TheHistorian parameters for the selected Block is shown in the panel on theright. The lower left pane of the dialog shows the Blocks contained inthe selected Compound. Each Block is shown with its name, type, and thename of its defining “parent”. For example, the Block named FC0250 ofCompound COMPND_(—)0200 is an instance of a PID derived from the userdefined parameter set for FLOW PID's.

If any parameters of the selected block had been assigned for historicaldata collection, the parameter name, the collection period, the changedelta required to trigger collection, the duration of the historicalcollection (in hours) and the user's description of the point are shownon the pane on the right. The “Show All” checkbox controls whether allthe Block's parameters are shown or just the ones which are currentlyassigned. The “Modify . . . ” button invokes a dialog which allowsediting of the selected parameter's collection specification.

-   -   Clicking on the “Change Assignments” button in the dialog box of        FIG. 110 invokes the dialog shown in FIG. 111. Compounds can be        added or removed from the selected Historian by selecting one or        more Compounds from one of the lists and using the “Add” and        “Remove” buttons. Similar dialogs are provided to allow        assigning Block Definitions to Historians.    -   The dialog which is provided to designate which block parameters        are to be assigned for collection and allow the entry and        editing of the collection information is a variation of the        standard Parameters Property Sheet. This dialog is available as        an “Historian” tab from the Block Parameters Property Page        dialog. The dialog shows a list of all connectable parameters        for the block and allows the user to assign Historian Collection        Point information on a per parameter basis and view which        parameters have already been assigned.

2.11.3 Functions

The functionality of the Historian Collection Point Editor can bedivided into four parts; import or creation of Historian systemconfigurations, assignment of block parameters for historicalcollection, assignment of Compounds to Historians and creation ofHistorian configuration files.

2.11.3.1 Historian Configuration

-   -   Manually enter the Historian name, type, hosting server and        capacity.    -   Import the Historian name, type, hosting server and capacity        from existing system configuration files.    -   Expose Historian Configuration functionality for use by the        Import/Export Manager.

2.11.3.2 Collection Assignment

-   -   Create a collection point assignment for any connectable block        parameter.    -   Edit the assignment parameters    -   Delete a collection point assignment.    -   Expose collection point assignment creation functionality for        use by the Import/Export Manager.

2.11.3.3 Compound Assignment

-   -   Assign a Compound to an Historian for collection    -   Delete a Compound from an Historian.

2.11.3.4 Configuration File Creation

-   -   Generate a configuration file for all the Compounds assigned to        an Historian.    -   Generate a configuration file for selected Compounds assigned to        an Historian.    -   Initiate the download of the configuration files to the selected        Historian(s). There are three, user selectable, modes of        download:        -   1. The existing configuration is forced to match the IDA            version, deleting current Historian collection points where            necessary.        -   2. Only add new collection points to the current Historian,            leaving the existing points untouched (including those in            which the IDA collection parameters differ from the current            Historian ones).        -   3. Add the new collection points and modify the existing            ones to match the IDA version, but does not delete any            current Historian points)

2.11.4 Class Descriptions 2.11.4.1 Historian

Referring to FIG. 111, an Historian is responsible for containing andcontrolling access to the Collection Points assigned to it. It isderived from the Framework Parameterized Object Collection class andadds data members to contain the Historian Name, Historian Type,Historian Capacity and Host Server. Since Compounds are assigned tohistorians for collection, the Historian class also contains a list ofreferences to its assigned Compounds. Class Relationships:

-   -   Historian only allows objects of type Collection Point to be        added to its parameter collection.    -   Historian uses the Parameterized Object Collection method to        provide iteration for the contained Collection Points.    -   Historian provides its own storage and method for iteration over        the Compounds which are assigned to it, returning each assigned        Compound in turn. The ordering of the list is to be determined.

2.11.4.2 Collection Point

A Collection Point is responsible for containing the parameters toconfigure a single block parameter for historical collection. It isderived from the Framework Parameterized Object class and is extended tocontain a reference to the Historian which contains it. ClassRelationships:

-   -   Collection Point contains the name of the compound, block and        parameter, the change delta, the collection frequency, the        storage duration, the number of values being stored and a user        defined description of the point as parameters. As loop        assignments to Compounds change, these parameters (particularly        compound and block names) change as well to reflect the new        names, if any. Each Collection Point is associated with only one        Historian.    -   All the parameters are contained in a single parameter group.    -   The Block/Parameter shown in the model is used to generate the        name information during collection point configuration        generation. The blocks and parameters used to provide this        information are extracted from the Compounds assigned to        Historians. The Collection Point class retains this information,        persistently, for purposes of reporting and display; there is no        physical reference maintained, only compound, block and        parameter name. Each Block/Parameter is associated with only one        Collection Point.

2.12 Enclosure Editor 2.12.1 Overview

The Enclosure Loading Editor is responsible for presenting the user witha graphical or tabular view of I/A Enclosures to allow placement anddocumentation of Modules, including (but not limited to) FBMs, CPS,gateways, DNBIs, and FBIs, in specific Enclosures and to allow assigningI/O Tags to specific FBM points. The documentation is used atinstallation time to help set up the equipment properly. SeveralEnclosures can be associated with a Plant area by creating them on acommon Enclosure Group drawing and then attaching the Enclosure Group toa branch on the Plant hierarchy tree. The Editor consists of two mainviews to accomplish these functions; the Enclosure Group view and theEnclosure Loading View. The IDA Framework standard list view can be usedto examine Enclosure Group data and Enclosure Loading data in read onlymode, and can be used to generate tabular reports.

2.12.2 Enclosure Editor Detailed Functionality 2.12.2.1 Enclosure GroupView

The enclosure group view will allow adding and deleting Enclosure Groupdrawings. The enclosure group view will allow adding and deletingEnclosures from Enclosure Group drawings. The enclosure group view willallow adding, deleting, and modifying connections among Enclosures onEnclosure Group drawings. The enclosure group view will allow relocatingEnclosures, either within a Group drawing or from the Project ManagerTree. The Enclosure Group view is used to create or modify a graphicaldrawing of enclosures that can be associated with a specific Plant area.The user selects an enclosure type from a palette and drops it onto adrawing view. Enclosures can be repositioned and “connected” (note thatsuch a connection is for annotation purposes only) on the drawing view.An enclosure that already exists can be relocated by dragging it fromthe Project Manager Tree view and dropping it onto the drawing.

2.12.2.2 Enclosure Group View User Interface

Referring to FIG. 113, the Enclosure Group view is a documentation tool.The enclosure groups and their assigned enclosures are saved in the IDAdatabase, but the Enclosure Editor does not check that all enclosuresare assigned to a group or that an enclosure is assigned to only onegroup, for example. The text and lines used to annotate the enclosuregroup view are saved in the IDA database in graphical form only—thelines do not represent connections in the same sense that they do inother editors like the Loop Sheet Editor. The Enclosure Editor does notcheck whether the information configured by the user matches thephysical layout of the system. The Enclosure Editor User Interface willfollow Microsoft conventions. The Enclosure Group View supports theability to find a particular Enclosure using standard Windowsconventions. By double clicking on an individual enclosure, or byselecting an enclosure and using the context menu, the user can changethe view from the Group view to the Loading view for the selectedEnclosure.

2.12.2.3 Enclosure Loading View Module Assignment Functions

-   -   The Enclosure Loading View provides for adding and deleting        Modules within Enclosures functions. It also provides for        relocating Modules, either within an Enclosure Loading view or        from the Project Manager Tree functions.

The Enclosure Loading view is used to assign FBMs to Enclosure slots andto assign I/O Tags to FBM points. The user can select an FBM type fromthe palette (the palette in the figure does not show this) and drop itonto an Enclosure slot. FBMs can be relocated in the following ways:

-   1. By dragging and dropping them to another slot.-   2. An FBM that already exists can be relocated by dragging it from    the Project Manager Tree view and dropping it onto one of the    Enclosure slots.-   3. By using standard Windows cut and paste.

In addition to FBMs, the Enclosure Editor allows the user to assignother module types, such as CPS, to slots. Such modules simply take upenclosure slots, as far as the Enclosure Editor is concerned, and areshown in a different color. The Enclosure Editor understands how to dealwith module variations, such as redundant modules and module extenders,that occupy more than one slot.

2.12.2.4 Enclosure Loading View I/O Tag Assignment Functions

By selecting an FBM point in one of the Enclosure slots, a user caninvoke the Tag Assignment dialog which allows assigning a specific I/OTag to the point. The dialog displays a subset of the fields in the TagList and only displays unassigned Tags. The user can locate a specificTag either by scrolling the Tag list or by entering a Tag name in the“Find” text box. The list can be sorted by any of the column headings toaid in locating an existing Tag. If a Tag does not yet exist, the usercan select the “New” button, which invokes the Tag List Editor.

Tags are added to FBM points by selecting a Tag list entry on the listand then dragging it onto an FBM point. This action causes the Tag nameto appear next to the respective FBM point in the Enclosure Loadingview. An error dialog box appears informing the user if there is amismatch of FBM point type and the Block type of the Tag. If the userattempts to assign a Tag to an FBM point that has an incompatibility(such as attempting to assign a Tag associated with an AIN Block inputto an FBM output point) an error dialog box appears explaining why theattempted action is not allowed.

Tags can be relocated, either within an enclosure or between enclosuresseveral ways:

-   1. By dragging and dropping the Tag to another location in the same    or a different FBM.-   2. A Tag that already exists can be relocated by dragging it from    the Project Manager Tree view and dropping it onto one of the FBM    slots (note that this implies that the tree view can show details    all the way down to the FBM point level).-   3. By instantiating another copy of the Enclosure Editor in a    separate IDA instance and dragging and dropping Tags between the    windows.-   4. By using standard Windows cut and paste.

Tags can also be attached to FBMs that exist in the Unassigned branch ofthe Project Manager Tree. These are FBMs that have been created but notyet assigned to a specific Enclosure slot. To attach Tags to one ofthese FBMs, the user selects the FBM on the Project Manager Tree andthen invokes the Enclosure Loading Editor. The Editor then displays aview of FBMs identical to that shown on the Enclosure Loading view, butwith just the single FBM. Tag list assignments are then made asdescribed previously.

The Enclosure Loading View allows the user to find either a particularFBM or Tag, using standard Windows conventions.

2.12.2.5 Enclosure Loading View User Interface

Referring to FIG. 114, the Enclosure and Module types available on theEnclosure Element lists are implementation-standard. The user does nothave the capability to add or modify these types of objects. Icons forModule types other than FBMs (such as a CP) are provided to enhance thedocumentation of occupied slots in the Enclosure cells.

Enclosures and loading configurations can be either built manually, asdescribed above, or imported from System Configurator or FoxCAE files asdescribed in the Import/Export Editor section of this document. Changesmade to imported configurations do not update the original Systemconfigurator files.

2.12.2.6 Input/Output Termination View Functions

The Input/Output Termination View is used to document which terminationpoint(s) to use for each FBM input and output. Each FBM Module has oneof three types of termination blocks, used to connect the FBM toexternal devices. This view is used to document, for the installationelectrician, which terminals to use when wiring the system. The I/OTermination View is automatically invoked whenever the Enclosure Loadingeditor is started. It shows a view of the Input/Output terminations usedto connect signals to FBMs. It allows the user to change which of thepossible termination points for each FBM is used for the connection. Itdoes not allow the user to perform any of the Tag assignment tasks (i.e.drag and drop, cut and paste) that are possible in the Enclosure Loadingview. It only allows the user to select which I/O contact point to use,of the available I/O contacts.

2.12.2.7 Input/Output Termination View User Interface

Referring to FIG. 115 the Input/Output Termination View shows contactsfor the corresponding Enclosure Loading View, grouped by FBM. Theselected FBM point in the Enclosure Loading View and the selected I/Oterminations in the I/O Termination View track each other when switchingbetween these two views. Associated with the Enclosure Editors, andincluded with the shippable IDA, are IDA definitions that describeimplementation-standard enclosures, cells and modules. Definitions forfuture and/or special enclosures, cells and modules can be generated.All of these definitions are created using the Definition Editor.

The Enclosure Editor provides functions for printing Enclosuredrawings—both Enclosure Group drawings and Enclosure Loading drawings.It also provides functions for printing tabular enclosure reports. Eachview in the Enclosure Editor represents a printable drawing. As such, itis associated with a sheet template that is assigned when the view iscreated. The aspect ratios of the associated sheet template aremaintained during all zoom and pan operations. The user can zoom in andout, depending upon the desired level of detail. Scroll barsautomatically appear and disappear as appropriate. The font used to showFBM information and tag names in the Enclosure Loading views isautomatically scaled based on the current zoom magnification, and ischosen such that the tag names are as large as possible within theirallotted spaces when the view is rendered as a drawing. If the currentmagnification is too low to render the scaled font, the text is notshown. The user can change the sheet template that is associated with aview, and if the sheet template is too small to allow tag names to beprinted, the user is warned.

2.12.2.8 Configuration Check Functions

A check configuration function will be provided to check that allmodules are assigned to enclosures, all I/O points are assigned to FBMs,etc. Type compatibility checking between FBM point types and Tags'associated input/output Block parameters. This validity checking is alsoused by the Block and Connection Editor when connecting Tags that havealready been associated with FBMs to Blocks on a Loop drawing view.

2.12.2.9 Enclosure Editor Import/Export Functions

Standard IDA import and export functions are provided to back up andrestore the database, or to transfer it to another IDA system. Functionsto import enclosure information from a System Configurator File or froma FoxCAE database are also provided. All imported enclosures will beassigned to the components branch on the Project Manager Tree and can besubsequently added by hand to Enclosure Group drawings.

2.12.3 Object Models

This section describes the object models for Enclosure loading,including the placement of Modules in specific Cell/Slot positionswithin enclosures. Parameterized Objects, Parameterized ObjectCollections, and Connections are described in detail in the Part 1 andonly a simplified model of the implementation of these classes is shownhere. Tag List Row and Block objects are described elsewhere in thisdocument. For clarity, the entire Definition models for Enclosure, Cellsand Modules are not shown in FIG. 96. The full model for an EnclosureDefinition is shown on the subsequent figure and applies for the otherDefinition classes as well. The last object model describes the use ofpersistent Document objects to display enclosure drawings.

2.12.3.1 Enclosure Group

Referring to FIG. 116, an Enclosure Group provides a means to groupEnclosures so they can be associated as a group with particular PlantAreas. Class Relationships:

-   -   An Enclosure Group is derived from Parameterized Object        Collection, which provides the ability to manage collections.    -   An Enclosure Group maintains associations with Enclosures which        are used to report on which Enclosures belong to the group.

2.12.3.2 Enclosure

Enclosures serve as a physical housing for Cells, which are mountingstructures for modules (such as FBMs). The Enclosure is capable ofcontaining one or more Cells. The main function of this class is to keeptrack of which Cells it contains. Each I/A enclosure has pre-definedCell types and both the Enclosure and its Cells are created when aninstance of an Enclosure is created. Class Relationships:

-   -   An Enclosure is derived from Parameterized Object, which        supports connections through its parameters.    -   An Enclosure is the container/parent for Cells and maintains an        ordered set of Cell connections.    -   An Enclosure can optionally be associated with an Enclosure        Group.    -   An Enclosure maintains an association with its Enclosure        Definition for reporting purposes (see FIG. 117 and discussion        below).    -   An association with a Placeholder is also maintained to support        supplying data for display purposes (see FIG. 118).

2.12.3.3 Cell

A Cell serves as a mounting structure for Modules (FBMs), and may belongto one, and only one, Enclosure. Modules are placed within specificsockets (or slots) which define the Cell. Each Module may “consume” oneor more adjacent sockets within the Cell. The main function of thisclass is to keep track of which Modules are loaded in its slots. ClassRelationships:

-   -   An Cell is derived from Parameterized Object, which supports        connections through its parameters.    -   A Cell maintains a connection to its associated Enclosure.    -   An Cell is the container/parent for Modules and maintains an        ordered set of Module connections.    -   A Cell maintains an association with its Cell Definition for        reporting purposes, similar to Enclosures.    -   An association with a Placeholder is also maintained to support        supplying data for display purposes (see FIG. 118).

2.12.3.4 Module

A Module is control hardware and/or nd peripherals which occupy aphysical location (socket, or slot) within a Cell. Note that suchmodules may mount directly in Cells or Enclosures. The main function ofthis class is to keep track of which Tag List Rows are loaded in itsslots. Class Relationships:

-   -   A Module is derived from Parameterized Object, which supports        connections through its parameters.    -   A Module maintains a connection to its associated Cell and/or        Enclosure.    -   An Module is the container/parent for Tag List Rows and        maintains an ordered set of Tag List Row connections.    -   A Module maintains an association with its Module Definition for        reporting purposes, similar to Enclosures.    -   An association with a Placeholder is also maintained to support        supplying data for display purposes (see FIG. 118).

2.12.3.5 Tag List Row

A Tag List Row represents a physical I/O connection point on an FBMModule. It's primary function is to map I/O points to Block I/Oparameters, such a an AIN MEAS input parameter.

Class Relationships:

-   -   A Tag List Row is a Block, which supports connections through        its parameters.    -   A Tag List Row maintains a connection with a Module which is        used to support reporting and display of Tag List Row Names and        associated Input/Output Blocks.

2.12.3.6 Nest Connection

A Nest Connection is a type of Framework Connection Class which is usedto implement the ability to contain objects within other objects inparticular slot positions. Class Relationships:

-   -   Nest Connection is derived from the Framework Parent/Child        Connection Class.    -   This class is used to implement Parent/Child relationships among        the Enclosure-related classes.

2.12.3.7 Enclosure Definition

The Enclosure Definition class serves as a factory class to createinstances of Enclosure objects in response to users dragging anEnclosure Type icon onto an Enclosure Group view in the editor. SinceEnclosures also have pre-determined Cell Types, this class alsoinitiates the creation of an Enclosure's associated Cells, when creatinga new Enclosure object. An Enclosure Definition exists for each type ofenclosure and contains specific parameters relating to the number ofCell slots supported by the enclosure. Enclosure Definitions arerepresented by icons on the Enclosure Editor palette and createEnclosure instances in response to users dragging icons from the paletteonto the drawing view. A Placeholder object, describing the geometry ofthe Enclosure Cell slot array is also associated with each Definition.Class Relationships:

-   -   An Enclosure Definition is derived from the Enclosure class,        which provides the ability to maintain an ordered set of Cells.    -   An Enclosure Definition maintains an ordered list of Cell Slot        Parameters, but connections are not allowed to be made to these        Definition parameters. Connections to Cells can only be made to        Enclosure Instances.    -   An Enclosure Definition maintains an association with a        Placeholder, which it uses in creating the Placeholder for        Enclosure Instances.    -   An Enclosure Definition maintains associations with the        Enclosures it creates to allow listing all Enclosures of its        type in response to report requests or listing requests from the        Project Manager Tree.

2.12.3.8 Enclosure Instance

An Enclosure Instance is an object generated by its related EnclosureDefinition. Class Relationships:

-   -   An Enclosure Instance is derived from the Enclosure class, which        provides the ability to maintain an ordered set of Cells.    -   An Enclosure Instance maintains an ordered list of Cell Slot        Parameters, which are used to maintain connections to related        Cells.    -   An Enclosure Instance maintains an association with a        Placeholder, which is used to represent the Enclosure Instance        on Enclosure drawings.    -   An Enclosure Instance maintains an association with its        Definition.

2.12.3.9 Enclosure Placeholder for Loading

This class holds all of the data associated with the drawing of aEnclosure within an Enclosure Loading view. Drawing information such aslocation, scale and selection status are maintained in this class. TheEnclosure Placeholder information cannot be modified by the user sinceEnclosures appear in a fixed location within the Enclosure Loading view.Class Relationships:

-   -   Enclosure Placeholder is derived from Parameterized Object        Placeholder.    -   The Enclosure Placeholder is contained in the Enclosure        Document, the collection point for all drawing data for an        Enclosure Loading view. The Enclosure Document contains only one        Enclosure Placeholder.    -   Enclosure Placeholder maintains a reference to its corresponding        Enclosure, to retrieve the data to display the Enclosure.

2.12.3.10 Cell Placeholder

This class holds all of the data associated with the drawing of a Cellwithin an Enclosure Loading view. Drawing information such as location,scale and selection status are maintained in this class. The CellPlaceholder information cannot be modified by the user since Cellsappear in a fixed location within the Enclosure Loading view. ClassRelationships:

-   -   Cell Placeholder is derived from Parameterized Object        Placeholder.    -   The Cell Placeholders are contained in the Enclosure Document,        the collection point for all drawing data for an Enclosure        Loading view.    -   Cell Placeholder maintains a reference its corresponding Cell,        to retrieve the data to display the Cell.

2.12.3.11 Module Placeholder

This class holds all of the data associated with the drawing of a Modulewithin an Enclosure Loading view. Drawing information such as location,scale and selection status are maintained in this class. The ModulePlaceholder information is updated in response to users relocatingModules within the Enclosure Loading view. The FBM Module Placeholdersalso display the Tag names associated with each FBM point and allow theuser to call up the Tag Assignment Dialog by selecting one of the pointlocations on the Placeholder. Class Relationships:

-   -   Module Placeholder is derived from Parameterized Object        Placeholder.    -   The Module Placeholders are contained in the Enclosure Document,        the collection point for all drawing data for an Enclosure        Loading view.    -   Module Placeholder maintains a reference its corresponding        Module, to retrieve the data to display the Module.

2.12.3.12 Enclosure Loading Document

This class encapsulates the drawing information to draw an entireEnclosure Loading view. This class contains information on scaling,orientation, and other style parameters. All other drawing informationis maintained within the contained classes. Class Relationships:

-   -   Enclosure Loading Document is derived from Persistent Document,        from which it inherits its drawing object collection functions        and the ability to be associated with a Sheet Template.    -   Enclosure Loading Document contains an Enclosure Loading        Placeholder    -   Enclosure Loading Document contains Cell Placeholders    -   Enclosure Loading Document contains Module Placeholders    -   Enclosure Loading Document maintains a reference its        corresponding Enclosure to respond to display requests.

2.12.3.13 Enclosure Placeholder for Group

This class holds all of the data associated with the drawing of aEnclosure within an Enclosure Group view. Drawing information such aslocation, scale and selection status are maintained in this class. TheEnclosure Placeholder information cannot be modified by the user sinceEnclosures appear in a fixed location within the Enclosure Loading view.Note that connections between Enclosures shown on Enclosure Groupdrawings are not modeled as associations between Enclosure objects, butare simply line annotations the user constructs on the drawing.

Class Relationships:

-   -   Enclosure Placeholder is derived from Parameterized Object        Placeholder.    -   The Enclosure Placeholder is contained in the Enclosure        Document, the collection point for all drawing data for an        Enclosure Loading view. The Enclosure Document contains only one        Enclosure Placeholder.    -   Enclosure Placeholder maintains a reference its corresponding        Enclosure, to respond to requests to display the Enclosure.

2.12.3.14 Enclosure Group Document

This class encapsulates the drawing information to draw an entireEnclosure Group view. This class contains information on scaling,orientation, and other style parameters. All other drawing informationis maintained within the contained classes.

Class Relationships:

-   -   Enclosure Group Document is derived from Persistent Document,        from which it inherits its drawing object collection functions        and the ability to be associated with a Sheet Template.    -   Enclosure Group Document contains Enclosure Placeholders    -   Enclosure Placeholder maintains a reference its corresponding        Enclosure Group to respond to display requests.

2.13 Reports 2.13.1 Overview

The Control Algorithm Configurator provides a set of pre-defined reporttemplates, in addition to the general-purpose query and reportcapabilities provided by the Framework Print Manager. These reportsprovide users with the capability to quickly generate a variety ofreports by selecting from a list of objects to which the reports apply.List boxes allow users to select a subset or all of the reportableobjects for any report template. For instance, the Plant Area reportdialog presents a list of all defined Plant Areas from which the usercan select one, several, or all. Each report includes an optional coversheet describing the name and description of the report and a table ofcontents if the report covers multiple items.

Report templates are provided for both tabular and graphical reports,such as Loop drawings. Using the Report Editor, users can copy theimplementation-standard templates and modify them to create their owncustom report templates by changing the object attributes, grouping, andfilters applied to the report template queries. For example, users cangenerate a custom report template based on the Area Partial Detailtemplate shown in the table below, but including only Parameter values(not formulas) and showing all parameters instead of only those withnon-default values.

Report Template Select Include Group by Filters Area Summary Plant AreasLoop names Sub-Area Sub-Areas Enclosure Names Sub-Area Module namesEnclosure Area Partial Plant Areas Loop names, Loop Sub-Area Show onlyParameters Detail Sub-Areas Template name Loop with non-default valuesBlock names, type Block, Group Parameter names, value, formula Enclosurenames, Sub-Area type Enclosure Module names, Cell, Slot

Standard and user-defined Report Templates can be grouped together inuser-created Group Templates to generate custom documentation books.Reports are structured so that they can be invoked from related editorsto report on entire objects or just their associated components. Forinstance, from a Control Algorithm Diagram Editor Loop drawing, a usercan generate a report of the entire Loop, or can select several Blocksand generate a Block report just for those Blocks.

Report Templates Contents Composite Block Summary Name, description,Block names, types Composite Block Full Detail Blocks, all BlockParameters Composite Block Partial Detail Blocks, Non-default BlockParameters Composite Block Drawing Full Composite Block drawing, LadderLogic, Sequence Code, Detail Calculation Block Instructions CompositeBlock Drawing Composite Block drawing Partial Detail

2.13.2 Loops

Reportable objects for this set of reports are chosen from a list ofLoops.

Report Templates Contents Loop Summary Name, Template, description,Plant Area Loop Full Detail Blocks, all Block Parameters Loop PartialDetail Blocks, Non-default Block Parameters Loop Drawing Full DetailLoop drawing, Ladder Logic, Sequence Code, Calculation BlockInstructions Loop Drawing Partial Detail Loop drawing

2.13.3 Blocks

Reportable objects for this set of reports are chosen from a list ofBlocks.

Report Templates Contents Block Summary Name, type, description,definition, Composite Block affiliation, Loop Block Full Detail allBlock Parameters, drawings for Sequence, PLB, and Calculation BlocksBlock Partial Detail Non-default Block Parameters Block Drawing Drawingsfor Sequence, PLB, and Calculation Blocks

2.13.4 Compounds

Reportable objects for this set of reports are chosen from a list ofCompounds.

Report Templates Contents Compound Summary Compound name, ControlProcessor, Compound Parameters Compound Block Summary Control Processor,Compound Parameters (including alarm groups), Block/ECB name, type,definition, Composite Block affiliation, Loop Compound Block Full Detailall Block parameters Compound Block Partial Non-default Block ParametersDetail Compound Block Phasing Block name, type, definition, Loop,Composite Block affiliation, period, phase, zone

2.13.5 Control Processors

Reportable objects for this set of reports are chosen from a list ofControl Processors, including AWs and APs running control.

Report Templates Contents CP Summary Name CP Compound Summary Compounds,parameters(including alarm groups) CP Block Summary Compounds, Compoundparameters, Blocks, ECBs/FBMs, name, type, definition, Composite Blockaffiliation, Loop CP Block Full Detail all Block parameters CP BlockPartial Detail Non-default Block Parameters CP Loading Phase loading perBlock, compound time and size CP Peer-to-Peer Peer-to-peer connections

2.13.6 Enclosures

Reportable objects for this set of reports are chosen from a list ofEnclosures.

Report Templates Contents Enclosure Summary FBM names, types, Cell, SlotEnclosure Detail FBM names, types, Cell, Slot, Points, Tag assignmentsEnclosure Loading Drawing Enclosure Loading Drawing

3 Framework Services

This section describes those Framework services which will be availableto the application developer when creating IDA applications.

3.1 Generic Window Services for IDA Editors

The IDA configuration system's user interface relies on one or moreEditors, each hosted in a Multiple Document Interface (MDI) style windowframe (referred to as a main editor frame). The editors are used tomodify the contents of the Document Objects that make up an I/Aconfiguration. Document objects each represent containers of on-screendepictions of configurable objects. Document types in IDA are associatedwith one or more editors, one of which is the default editor.

For scalability, IDA editors are designed to be released as individualDLL's, all running under a single application. Each editor forms aDoc/Frame/View tuple (or Document Template) which has been written toedit specific object types in a certain way. In this manner, as newobjects and/or editors are developed for IDA, only the DLL's dealingwith the new editors need to be distributed to existing implementations.

The Framework provides two basic types of generic editors:

-   -   Generic Graphical Editor—a Document Template which allows the        developer to create a graphical editor in which objects are        created via drag/drop from the System Tree, and connected by        dragging one or more depictions of objects to a target object.        This generic editor will also provide basic drawing capability,        allowing the user to enhance the sheet with various annotations        such as text blocks, shapes with varying fill and colors, and        bitmaps. Two editors which could potentially use this generic        editor include the loop sheet, and the enclosure drawing        editors.    -   Generic Grid Editor—a Document Template which presents a        spreadsheet like view of objects to the user. Two editors        potentially utilizing this type of generic editor might include        the list view associated with each object type, and the Block        Definition Editor.

As depicted in FIG. 119, as each editor is activated via an objectselection (or some other means), it becomes the “active” DocumentTemplate for the particular editor frame. Only one Document Template canbe “active” at a time. Each Document Template knows how to deal with theobjects it is able to edit. The editors may present an edit capabilityto the user in a graphical format, in a grid (spreadsheet-like) format,or other appropriate format depending upon the object being edited, andthe context it is being edited in.

As depicted in FIG. 120, an IDA editor runs in a generic editor framecomposed of six major GUI components: Menu bar; Toolbars; A tabbededitor window, or view; A tabbed tree control; Palette(s);Output/message window. All GUI components (with the exception of themenu bar and the editor window) are able to be toggled on/off by theuser in order to maximize the screen “real estate” available for theeditor.

3.1.1 Menu Bar

The menu bar (depicted as GUI component 1 in FIG. 120) allows the userto interact with, and issue commands to, the application. The menu barprovides a means for the user to view and select an action to performrelative to either the application, or the current editor. There areessentially two sets of menus—those menu selections which are normallyconsidered part of the application, and those menu selections which areunique to the current editor. Each editor brings to the table its ownunique set of menu selections. Whenever an editor is selected (refer to3.1.3—Tabbed Editor Window), its unique menu selections are merged withthose of the main application, resulting in a cohesive set of menuselections available to the user. When no editor is current, the menuselections which appear to the user are only those associated with themain application.

3.1.2 Toolbars

The toolbars (depicted as GUI component 2 in FIG. 120 provides the userwith a shortcut to the menu command each toolbar button is associatedwith. As with menus, the main application has toolbars associated withit, as does each editor. When an editor is selected, the toolbar(s)associated with the editor are merged with the toolbar(s) associatedwith the main application, and the user is presented with a cohesive setof toolbar GUI components. Generally speaking, each menu selectionpotentially available via menu pulldown will also be available as atoolbar button.

While IDA includes default toolbars, users can customize their toolbarswith the toolbar buttons they use most often. In addition, users cancreate their own toolbars, placing whatever toolbar buttons they want ontheir own toolbars. Toolbars may be hidden by the user by picking theappropriate menu selection from the main menu, or right mouse clickingon the toolbar, and selecting “Hide” on the resulting popup menu.

3.1.3 Tabbed Editor Window

The tabbed editor window (depicted as GUI component 3 in FIG. 120)allows the user to create and modify configuration objects in variousways.

The Framework provides the developer with a choice of two types ofgeneric editors:

-   1. Graphics-based editor, allowing the user to manipulate objects in    a graphical manner on a graphical “sheet”, or canvas. Most    operations are done via drag/drop, including the establishment of    connections between objects. Depending on the editor, users can also    add their own annotations to the sheet, in the form of text blocks,    lines, bitmaps, and a variety of common shapes.-   2. Grid-based editor, allowing the user to manipulate objects in a    spreadsheet-like editor. Objects are represented as rows of data in    the spreadsheet, and the user will be allowed to specify various    properties such as sorting the data on particular columns, column    widths, etc.

Each editor written for IDA is contained within its own .DLL. Objecttypes within IDA are associated with one or more editors which arecapable of modifying them. One of those editors will be that objecttype's default editor (e.g. the default editor for a loop might be aloop drawing).

When an object is selected in the System/Plant hierarchy (i.e., treecontrol), all the editors (i.e., .document templates) associated withthat object's type are loaded into the application, and instantiatedwithin the tab control representing the tabbed editor window. Eacheditor is associated with a separate tab. If a tab is selected, thewindow containing that associated editor's document template moves tothe front, and that editor becomes the current editor.

While an editor is active, the user creates, modifies and deletesconfiguration components using that editor as a configuration tool. Eacheditor provides unique mechanisms, or methods, allowing the user tointeract with configuration components in ways unique to that editor.When an editor becomes the current editor, menu and toolbar selectionsunique to that editor are merged with those of the main application's inorder to present a cohesive set of menus and toolbars to the user.Conversely, when an editor is replaced by another editor, the originaleditor's menus and toolbars are removed from their respective GUIcomponents.

3.1.4 Tabbed Tree Control

The tree control (depicted as GUI component 4 in FIG. 120) allows theuser to quickly navigate to various portions of the configuration. IDAwill initially be released with two tabs representing two differenthierarchies with this GUI component:

-   -   1. System. This tab presents the System hierarchy to the user.        There are many “sections” to the System hierarchy, and the user        views items in a different context depending upon what section        they are looking at. For example, under “Components”, the user        sees a mix of definitions and instances in order to accurately        depict an inheritance chain, whereas under “Library”, the user        views definitions, since all portions of the “Library” are meant        to only act as a means of accessing the definition of items that        can be created. Even though the user can manually alter the        contents of portions of the System hierarchy (e.g. drag a CP        from one node to another), all portions of the System hierarchy        are able to be constructed dynamically from data specified in        the database.    -   2. Plant. This tab presents the Plant hierarchy to the user, and        is constructed and maintained by the user. It will be delivered        to the user with a single node (i.e., “The Plant”). Unlike the        System hierarchy, there is no automated mechanism for placing        configuration items in the Plant hierarchy other than by        explicit assignment of those items to specific plant areas        (probably via drag/drop). This hierarchy, while presenting        configuration components in a different context, may be viewed        simply an extension of the System hierarchy, using different        nodes (or “folders”) in the hierarchy to act as containers for        configuration items.

The entire tabbed tree control can be hidden from view by choosing theappropriate menu selection, or by right clicking on the tree control(somewhere off the tree nodes themselves) and selecting “Hide”. Thiswill allow the user to maximize the amount of screen space available tothe current editor.

3.1.5 Palette

The palette (depicted as GUI component 5 in FIG. 120) allows the user toplace “favorite” definitions (those used most often) in various palettesso that they are available when needed. The palette provides a shortcutmechanism to configuration item creation, and allows the user to createitems without having to do a lengthy search through the System hierarchylooking for the correct definition.

Definitions may be placed on the palette by dragging and dropping themfrom the appropriate definition within the System tree control. Multiplepalettes can be created, allowing the user to place a variety ofdefinitions into logical groups, such as “Common Blocks”, or “LoopTemplates”. Once a palette is created, it may be shared among users, sothat companies can standardize their palettes in whatever way they wishin order to make the configuration environment as efficient as possible.The entire palette control can be hidden from view by making theappropriate menu selection, or by right clicking on the palette (not ona palette item) and selecting “Hide”. This allows the user to maximizethe amount of screen space available to the current editor.

3.1.6 Output/Message Window

The output window (depicted as GUI component 6 in FIG. 120) allows theuser to view messages associated with various processes that are meantto be informative, and let the user know about the state of certainoperations as they are performed. An example of a process which utilizesthe output window is the “Find” utility, which allows the user to findoccurrences of a string within the database, given certain selectioncriteria. The “Find” utility opens its own output window, using a tablabeled “Find”. Each time it located an object that satisfied the searchcriteria, it outputs a reference to that object in the output window. Afurther enhancement to the output window would be to allow the user toselect, or double click, the object referenced, and activate theproperty pages associated with that object, allowing the user to viewadditional details about that object, or edit the object itself. Theentire output window can be hidden from view by making the appropriatemenu selection, or by right clicking on the output window and selecting“Hide”. This will allow the user to maximize the amount of screen spaceavailable to the current editor.

Described above are methods and apparatus meeting the objects and goalsset thereforth. Those skilled in the art will appreciate that theembodiments shown in the drawings and described in the accompanying textare merely examples and that other embodiments, incorporatingmodifications and changes therein, fall within the scope of theinvention. Thus, by way of non-limiting example, it will appreciatedthat other programming constructs such as, by non-limiting example,records, “structs,” arrays, and tables, may be utilized in place of thedata structures referred to as “objects” above. By way of furthernon-limiting example, methods and apparatus according to the inventioncan be used to model and configure control systems other than those usedfor process control such as, by non-limiting example, environmentalcontrol systems. In view thereof.

1-134. (canceled)
 135. (canceled)
 136. Apparatus for configuring acontrol system, comprising a model representing a configuration of atleast one of the control system and a system controlled thereby, and arecord of at least selected changes made to at least one of theconfiguration and the model, wherein the model comprises a plurality ofobjects representing entities in any of the control system and thesystem controlled thereby, and wherein the apparatus further comprisesmultiple versions of at least one of the objects, at least selected onesof those multiple versions reflecting changes made to at least one ofthe configuration and the model.
 137. Apparatus according to claim 136,wherein the multiple versions include a current version and a priorhistorical version.
 138. Apparatus according to claim 136, wherein themultiple versions include an offline version that forms at least part ofthe model, and an online version representing data executing in thecontrol system.
 139. Apparatus according to claim 138, wherein theonline version is in a format understandable by the control system. 140.(canceled)
 141. Apparatus for configuring a control system, theapparatus comprising a first database comprising a model representing aconfiguration of at least one of the control system and a systemcontrolled thereby, the first database comprising a record of changesmade to at least one of the configuration and the model, wherein thefirst database comprises a collection of objects that make up at leastpart of the model, the objects representing entities in any of thecontrol system and the system controlled thereby, the first databasecomprises multiple versions of at least one of the objects, at leastselected ones of those multiple versions reflecting changes made to atleast one of the configuration and the model.
 142. Apparatus accordingto claim 141, wherein the multiple versions include a current versionand a prior historical version.
 143. Apparatus according to claim 141,comprising a second database representing data executing in the controlsystem.
 144. Apparatus according to claim 143, wherein the seconddatabase stores objects corresponding to objects in the first databasethat make up the model.
 145. Apparatus according to claim 143, whereinthe second database stores data in a format understandable by thecontrol system.
 146. Apparatus according to claim 145, wherein thesecond database stores objects corresponding to objects in the firstdatabase that make up the model.
 147. Apparatus according to claim 143,comprising a third database comprising a version of an object in thefirst database being modified by a first user. 148-149. (canceled) 150.Apparatus for configuring a control system, comprising a modelrepresenting a configuration of at least one of the control system and asystem controlled thereby, the model comprising a plurality of objects,the objects representing entities in any of the control system and thesystem controlled thereby, multiple versions of at least one of theobjects, the multiple versions including a version that forms part ofthe model, and an online version representing data executing in thecontrol system, wherein at least one of (i) an identity of an object and(ii) an address, pointer or other reference to the object remainsconstant.
 151. Apparatus according to claim 150, wherein said at leastone of (i) the identity of an object and (ii) the address, pointer orother reference to the object remains constant during the lifetime ofthat object.
 152. Apparatus according to claim 150, wherein at least aselected one of the versions reflects changes made to at least one ofthe configuration and the model.
 153. Apparatus according to claim 152,wherein the multiple versions include a current version and a priorhistorical version.
 154. Apparatus according to claim 150, wherein theonline version in a format understandable by the control system. 155.Apparatus for configuring a control system, comprising a modelrepresenting a configuration of at least one of the control system and asystem controlled thereby, the model comprising a plurality of objectsrepresenting entities in any of the control system and the systemcontrolled thereby, and multiple versions of at least one of theobjects, the multiple versions including a current version and a priorhistorical version, wherein the multiple versions comprise a currentversion and a workspace version of an object being modified, and whereinthe current version of an object being modified by a first user isblocked from modification by one or more other users. 156-157.(canceled)
 158. Apparatus according to claim 155, wherein the currentversion of an object being modified by the first user is available forread-only access by the one or more other users.
 159. Apparatusaccording to claim 155, wherein a workspace version of an object beingmodified is available for access only by the first user.
 160. Apparatusaccording to claim 155, wherein at least one of the current version andthe workspace version includes a designation of a user making themodification.
 161. Apparatus according to claim 155, wherein themultiple versions comprise a current version and a modified version.162. Apparatus according to claim 161, wherein at least one of thecurrent version and modified version includes a designation of a userwho made the modification, an identification of a modification made, andreason therefor.
 163. Apparatus according to claim 161, wherein thecurrent version is designated as a prior version and the modifiedversion is designated as the current version.
 164. (canceled) 165.Apparatus for configuring a control system, comprising a modelrepresenting a configuration of at least one of the control system and asystem controlled thereby, the model comprising a plurality of objectsrepresenting entities in any of the control system and the systemcontrolled thereby, and multiple versions of a plurality of the objects,the multiple versions including offline versions that form part of themodel, online versions representing data executing in the controlsystem, and the multiple versions including, for at least one of theobjects, a current version and a modified version, wherein at least oneof the current version and the modified version references the other.166. Apparatus according to claim 165, wherein the multiple versionsinclude an online version corresponding to a modified version. 167.(canceled)
 168. Apparatus according to claim 165, wherein at least oneof the current version and modified version includes a designation of auser who made the modification, an identification of a modificationmade, and reason therefore.
 169. Apparatus according to claim 168,wherein the current version is designated as a prior version and themodified version is designated as the current version. 170-173.(canceled)
 174. Apparatus according to claim 173, wherein at least oneof the current version and the prior version references the other. 175.Apparatus for configuring a control system, comprising: a modelrepresenting a configuration of at least one of the control system and asystem controlled thereby, a record of at least selected changes made toat least one of the configuration and the model, functionality thatpermits any of viewing and editing information pertaining to thechanges, wherein the functionality permits any of viewing a listing ofobjects being modified, recording changes made to objects, recordingreasons for changes to objects, releasing locks on objects, checking-inobjects that have been checked-out for modification, viewing a versionhistory of an object, comparing objects, comparing versions of anobject, compacting a version history, marking at least selected objectswith a common revision identification, archiving any of a model and ahistory of changes thereto, generating an audit trail of changes to oneor more objects.
 176. (canceled)
 177. Apparatus according to claim 175,comprising a first database that stores the model.
 178. Apparatusaccording to claim 177, wherein the first database comprises acollection of objects that make up at least part of the model, theobjects representing entities in any of the control system and thesystem controlled thereby, the first database comprises multipleversions of at least one of the objects, at least selected ones of thosemultiple versions reflecting changes made to at least one of theconfiguration and the model.
 179. Apparatus according to claim 178,wherein the multiple versions include a current version and a priorhistorical version.
 180. Apparatus according to claim 177, comprising asecond database representing data executing in the control system. 181.Apparatus according to claim 180, wherein the second database storesobjects corresponding to objects in the first database that make up themodel.
 182. Apparatus according to claim 180, wherein the seconddatabase stores data in a format understandable by the control system.183. (canceled)
 184. Apparatus according to claim 180, comprising athird database comprising a version of an object in the first databasebeing modified by a first user. 185-186. (canceled)
 187. Apparatus forconfiguring a control system, comprising a first model representing afirst configuration of at least one of the control system and a systemcontrolled thereby, and a second model representing a secondconfiguration of at least one of the same control system and the samesystem controlled thereby, a third model representing a thirdconfiguration of at least one of the same control system and the samesystem controlled thereby, the third model representing a merge of thefirst and second models.
 188. Apparatus according to claim 187, whereinthe second model is a copy of the first model that has been modifiedindependently of the first model.
 189. Apparatus according to claim 188,wherein the second model is modified on a computer separate from acomputer on which the first model resides.
 190. Apparatus according toclaim 189, comprising a record of modifications to the second model,which record can be played against the first model in connection withmerging those two models.
 191. Apparatus according to claim 188, whereinthe first and second models comprise respective pluralities of objectsrepresenting entities in any of the control system and the systemcontrolled thereby, and at least selected ones of the objects areassociated with unique identifiers.
 192. Apparatus according to claim191, wherein the identifiers are globally unique identifiers. 193.Apparatus for configuring a control system, comprising a modelrepresenting a configuration of at least one of the control system and asystem controlled thereby, a record of at least selected changes made toat least one of the configuration and the model, a mechanism, coupled tothe model and to the record, that reinstates a prior version of themodel.
 194. Apparatus according to claim 193, wherein the recordcomprises a prior model, or portion thereof, and the mechanism replacesat least a portion of the current model with that prior model, orportion thereof.
 195. Apparatus according to claim 194, wherein therecord comprises a record of modifications to the prior model, themechanism replaces at least a portion of the current model with theprior model, or portion thereof and plays the record of modificationsthere against.
 196. Apparatus according to claim 193, wherein themechanisms rolls back the model or a prior version thereof based on therecord.
 197. Method of configuring a control system, comprisingrepresenting a configuration of at least one of the control system and asystem controlled thereby with a model, and maintaining a record of atleast selected changes made to at least one of the configuration and themodel, wherein the model comprises a plurality of objects representingentities in any of the control system and the system controlled thereby,and wherein the method further comprises maintaining multiple versionsof at least one of the objects, at least selected ones of those multipleversions reflecting changes made to at least one of the configurationand the model.
 198. Method according to claim 197, wherein the modelcomprises a plurality of objects representing entities in any of thecontrol system and the system controlled thereby, and wherein the methodfurther comprises maintaining multiple versions of at least one of theobjects, at least selected ones of those multiple versions reflectingchanges made to at least one of the configuration and the model. 199.Method according to claim 197, wherein the step of maintaining multipleversions includes the step of maintaining a current version and a priorhistorical version.
 200. Method according to claim 197, wherein the stepof maintaining multiple versions includes the step of maintaining anoffline version that forms at least part of the model, and an onlineversion representing data executing in the control system.
 201. Methodaccording to claim 200, wherein the online version in a formatunderstandable by the control system. 202-258. (canceled)